Close httplib2 connections.
create(parent, body=None, securityProfileId=None, x__xgafv=None)
Creates a new security profile in a given organization and location.
delete(name, etag=None, x__xgafv=None)
Deletes a single security profile.
Gets details of a single security profile.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists security profile resources in a given organization and location.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single security profile.
close()
Close httplib2 connections.
create(parent, body=None, securityProfileId=None, x__xgafv=None)
Creates a new security profile in a given organization and location.
Args:
parent: string, Required. The parent resource of the `SecurityProfile`. Format: `organizations/{organization}/locations/{location}` or `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # A resource that defines the behavior for one of many `ProfileType` values.
"createTime": "A String", # Output only. Resource creation timestamp.
"customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom network security in-band integration configuration for the `SecurityProfile`.
"interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.
},
"customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom network security out-of-band integration configuration for the `SecurityProfile`.
"mirroringEndpointGroup": "A String", # Required. Immutable. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.
},
"description": "A String", # Optional. An optional description of the profile. The maximum length is 512 characters.
"etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. Name of the `SecurityProfile` resource. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`.
"threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the `SecurityProfile`.
"antivirusOverrides": [ # Optional. Configuration for overriding antivirus actions per protocol.
{ # Defines what action to take for antivirus threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
{ # Defines what action to take for a specific severity match.
"action": "A String", # Required. Threat action override.
"severity": "A String", # Required. Severity level to match.
},
],
"threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
{ # Defines what action to take for a specific threat_id match.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"threatId": "A String", # Required. Vendor-specific ID of a threat to override.
"type": "A String", # Output only. Type of the threat (read only).
},
],
},
"type": "A String", # Immutable. The single `ProfileType` that the `SecurityProfile` resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
"urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the `SecurityProfile`.
"urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
{ # A URL filter defines an action to take for some URL match.
"filteringAction": "A String", # Required. The action taken when this filter is applied.
"priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
"urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
"A String",
],
},
],
},
"wildfireAnalysisProfile": { # `WildfireAnalysisProfile` defines Palo Alto Networks WildFire behavior. # The Advanced malware sandbox analysis configuration for the `SecurityProfile`.
"wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for Advanced malware sandbox inline cloud analysis.
{ # The list of file type configurations to be scanned by Advanced malware sandbox inline cloud analysis.
"action": "A String", # Required. Action to take when a threat is detected using Advanced malware sandbox inline cloud analysis. The default value is `DENY`.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox inline cloud analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox inline cloud analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox inline cloud analysis.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox inline cloud analysis.
},
],
"wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox inline ML threats per protocol.
"action": "A String", # Required. The action to take for Advanced malware sandbox inline ML override.
"protocol": "A String", # Required. Protocol to match for Advanced malware sandbox inline ML override.
},
],
"wildfireInlineMlSetting": { # Defines the settings for Advanced malware sandbox inline ML analysis. # Optional. Settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
"wildfireInlineMlSettings": [ # Optional. Deprecated: Use `wildfire_inline_ml_setting` instead. Settings for Advanced malware sandbox inline ML analysis.
{ # Defines the settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
],
"wildfireOverrides": [ # Optional. Configuration for overriding Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the Advanced malware sandbox real-time signature cloud performs a signature lookup. The default value is `false`.
"wildfireSubmissionRules": [ # Optional. Configurations for Advanced malware sandbox (WildFire) file submissions.
{ # Defines the file types to be submitted for Advanced malware sandbox analysis and the direction of the traffic.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox analysis.
},
],
"wildfireThreatOverrides": [ # Optional. Configuration for overriding the Advanced malware sandbox threat action by `threat_id` match.
{ # Defines what action to take for a specific Advanced malware sandbox `threat_id` match.
"action": "A String", # Required. Threat action override.
"threatId": "A String", # Required. Threat ID to match.
},
],
},
}
securityProfileId: string, Required. Short name of the `SecurityProfile` resource to be created. This value must be 1 to 63 characters long, contain only lowercase letters, numbers, and hyphens, and must not start with a number. For example, `security-profile1`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, etag=None, x__xgafv=None)
Deletes a single security profile.
Args:
name: string, Required. The name of the `SecurityProfile` to delete. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`. (required)
etag: string, Optional. If the client-provided `etag` is out of date, the delete request returns an `ABORTED` error.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets details of a single security profile.
Args:
name: string, Required. The name of the `SecurityProfile` to get. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource that defines the behavior for one of many `ProfileType` values.
"createTime": "A String", # Output only. Resource creation timestamp.
"customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom network security in-band integration configuration for the `SecurityProfile`.
"interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.
},
"customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom network security out-of-band integration configuration for the `SecurityProfile`.
"mirroringEndpointGroup": "A String", # Required. Immutable. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.
},
"description": "A String", # Optional. An optional description of the profile. The maximum length is 512 characters.
"etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. Name of the `SecurityProfile` resource. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`.
"threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the `SecurityProfile`.
"antivirusOverrides": [ # Optional. Configuration for overriding antivirus actions per protocol.
{ # Defines what action to take for antivirus threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
{ # Defines what action to take for a specific severity match.
"action": "A String", # Required. Threat action override.
"severity": "A String", # Required. Severity level to match.
},
],
"threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
{ # Defines what action to take for a specific threat_id match.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"threatId": "A String", # Required. Vendor-specific ID of a threat to override.
"type": "A String", # Output only. Type of the threat (read only).
},
],
},
"type": "A String", # Immutable. The single `ProfileType` that the `SecurityProfile` resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
"urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the `SecurityProfile`.
"urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
{ # A URL filter defines an action to take for some URL match.
"filteringAction": "A String", # Required. The action taken when this filter is applied.
"priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
"urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
"A String",
],
},
],
},
"wildfireAnalysisProfile": { # `WildfireAnalysisProfile` defines Palo Alto Networks WildFire behavior. # The Advanced malware sandbox analysis configuration for the `SecurityProfile`.
"wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for Advanced malware sandbox inline cloud analysis.
{ # The list of file type configurations to be scanned by Advanced malware sandbox inline cloud analysis.
"action": "A String", # Required. Action to take when a threat is detected using Advanced malware sandbox inline cloud analysis. The default value is `DENY`.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox inline cloud analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox inline cloud analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox inline cloud analysis.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox inline cloud analysis.
},
],
"wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox inline ML threats per protocol.
"action": "A String", # Required. The action to take for Advanced malware sandbox inline ML override.
"protocol": "A String", # Required. Protocol to match for Advanced malware sandbox inline ML override.
},
],
"wildfireInlineMlSetting": { # Defines the settings for Advanced malware sandbox inline ML analysis. # Optional. Settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
"wildfireInlineMlSettings": [ # Optional. Deprecated: Use `wildfire_inline_ml_setting` instead. Settings for Advanced malware sandbox inline ML analysis.
{ # Defines the settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
],
"wildfireOverrides": [ # Optional. Configuration for overriding Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the Advanced malware sandbox real-time signature cloud performs a signature lookup. The default value is `false`.
"wildfireSubmissionRules": [ # Optional. Configurations for Advanced malware sandbox (WildFire) file submissions.
{ # Defines the file types to be submitted for Advanced malware sandbox analysis and the direction of the traffic.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox analysis.
},
],
"wildfireThreatOverrides": [ # Optional. Configuration for overriding the Advanced malware sandbox threat action by `threat_id` match.
{ # Defines what action to take for a specific Advanced malware sandbox `threat_id` match.
"action": "A String", # Required. Threat action override.
"threatId": "A String", # Required. Threat ID to match.
},
],
},
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists security profile resources in a given organization and location.
Args:
parent: string, Required. The project or organization and location from which the `SecurityProfile` resources are listed. Format: `organizations/{organization}/locations/{location}` or `projects/{project}/locations/{location}`. (required)
pageSize: integer, Optional. Maximum number of `SecurityProfile` resources to return per call. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the server picks an appropriate default.
pageToken: string, Optional. A page token, received from a previous `ListSecurityProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSecurityProfiles` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response returned by the `ListSecurityProfiles` method.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"securityProfiles": [ # List of `SecurityProfile` resources.
{ # A resource that defines the behavior for one of many `ProfileType` values.
"createTime": "A String", # Output only. Resource creation timestamp.
"customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom network security in-band integration configuration for the `SecurityProfile`.
"interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.
},
"customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom network security out-of-band integration configuration for the `SecurityProfile`.
"mirroringEndpointGroup": "A String", # Required. Immutable. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.
},
"description": "A String", # Optional. An optional description of the profile. The maximum length is 512 characters.
"etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. Name of the `SecurityProfile` resource. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`.
"threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the `SecurityProfile`.
"antivirusOverrides": [ # Optional. Configuration for overriding antivirus actions per protocol.
{ # Defines what action to take for antivirus threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
{ # Defines what action to take for a specific severity match.
"action": "A String", # Required. Threat action override.
"severity": "A String", # Required. Severity level to match.
},
],
"threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
{ # Defines what action to take for a specific threat_id match.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"threatId": "A String", # Required. Vendor-specific ID of a threat to override.
"type": "A String", # Output only. Type of the threat (read only).
},
],
},
"type": "A String", # Immutable. The single `ProfileType` that the `SecurityProfile` resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
"urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the `SecurityProfile`.
"urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
{ # A URL filter defines an action to take for some URL match.
"filteringAction": "A String", # Required. The action taken when this filter is applied.
"priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
"urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
"A String",
],
},
],
},
"wildfireAnalysisProfile": { # `WildfireAnalysisProfile` defines Palo Alto Networks WildFire behavior. # The Advanced malware sandbox analysis configuration for the `SecurityProfile`.
"wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for Advanced malware sandbox inline cloud analysis.
{ # The list of file type configurations to be scanned by Advanced malware sandbox inline cloud analysis.
"action": "A String", # Required. Action to take when a threat is detected using Advanced malware sandbox inline cloud analysis. The default value is `DENY`.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox inline cloud analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox inline cloud analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox inline cloud analysis.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox inline cloud analysis.
},
],
"wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox inline ML threats per protocol.
"action": "A String", # Required. The action to take for Advanced malware sandbox inline ML override.
"protocol": "A String", # Required. Protocol to match for Advanced malware sandbox inline ML override.
},
],
"wildfireInlineMlSetting": { # Defines the settings for Advanced malware sandbox inline ML analysis. # Optional. Settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
"wildfireInlineMlSettings": [ # Optional. Deprecated: Use `wildfire_inline_ml_setting` instead. Settings for Advanced malware sandbox inline ML analysis.
{ # Defines the settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
],
"wildfireOverrides": [ # Optional. Configuration for overriding Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the Advanced malware sandbox real-time signature cloud performs a signature lookup. The default value is `false`.
"wildfireSubmissionRules": [ # Optional. Configurations for Advanced malware sandbox (WildFire) file submissions.
{ # Defines the file types to be submitted for Advanced malware sandbox analysis and the direction of the traffic.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox analysis.
},
],
"wildfireThreatOverrides": [ # Optional. Configuration for overriding the Advanced malware sandbox threat action by `threat_id` match.
{ # Defines what action to take for a specific Advanced malware sandbox `threat_id` match.
"action": "A String", # Required. Threat action override.
"threatId": "A String", # Required. Threat ID to match.
},
],
},
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single security profile.
Args:
name: string, Immutable. Identifier. Name of the `SecurityProfile` resource. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`. (required)
body: object, The request body.
The object takes the form of:
{ # A resource that defines the behavior for one of many `ProfileType` values.
"createTime": "A String", # Output only. Resource creation timestamp.
"customInterceptProfile": { # CustomInterceptProfile defines in-band integration behavior (intercept). It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP action. # The custom network security in-band integration configuration for the `SecurityProfile`.
"interceptEndpointGroup": "A String", # Required. The target InterceptEndpointGroup. When a firewall rule with this security profile attached matches a packet, the packet will be intercepted to the location-local target in this group.
},
"customMirroringProfile": { # CustomMirroringProfile defines out-of-band integration behavior (mirroring). It is used by mirroring rules with a MIRROR action. # The custom network security out-of-band integration configuration for the `SecurityProfile`.
"mirroringEndpointGroup": "A String", # Required. Immutable. The target MirroringEndpointGroup. When a mirroring rule with this security profile attached matches a packet, a replica will be mirrored to the location-local target in this group.
},
"description": "A String", # Optional. An optional description of the profile. The maximum length is 512 characters.
"etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"labels": { # Optional. Labels as key-value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. Identifier. Name of the `SecurityProfile` resource. Format: `organizations/{organization}/locations/{location}/securityProfiles/{security_profile}` or `projects/{project}/locations/{location}/securityProfiles/{security_profile}`.
"threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the `SecurityProfile`.
"antivirusOverrides": [ # Optional. Configuration for overriding antivirus actions per protocol.
{ # Defines what action to take for antivirus threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
{ # Defines what action to take for a specific severity match.
"action": "A String", # Required. Threat action override.
"severity": "A String", # Required. Severity level to match.
},
],
"threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
{ # Defines what action to take for a specific threat_id match.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"threatId": "A String", # Required. Vendor-specific ID of a threat to override.
"type": "A String", # Output only. Type of the threat (read only).
},
],
},
"type": "A String", # Immutable. The single `ProfileType` that the `SecurityProfile` resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
"urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the `SecurityProfile`.
"urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
{ # A URL filter defines an action to take for some URL match.
"filteringAction": "A String", # Required. The action taken when this filter is applied.
"priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
"urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
"A String",
],
},
],
},
"wildfireAnalysisProfile": { # `WildfireAnalysisProfile` defines Palo Alto Networks WildFire behavior. # The Advanced malware sandbox analysis configuration for the `SecurityProfile`.
"wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for Advanced malware sandbox inline cloud analysis.
{ # The list of file type configurations to be scanned by Advanced malware sandbox inline cloud analysis.
"action": "A String", # Required. Action to take when a threat is detected using Advanced malware sandbox inline cloud analysis. The default value is `DENY`.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox inline cloud analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox inline cloud analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox inline cloud analysis.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox inline cloud analysis.
},
],
"wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox inline ML threats per protocol.
"action": "A String", # Required. The action to take for Advanced malware sandbox inline ML override.
"protocol": "A String", # Required. Protocol to match for Advanced malware sandbox inline ML override.
},
],
"wildfireInlineMlSetting": { # Defines the settings for Advanced malware sandbox inline ML analysis. # Optional. Settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
"wildfireInlineMlSettings": [ # Optional. Deprecated: Use `wildfire_inline_ml_setting` instead. Settings for Advanced malware sandbox inline ML analysis.
{ # Defines the settings for Advanced malware sandbox inline ML analysis.
"fileExceptions": [ # Optional. List of files to exclude from Advanced malware sandbox inline ML analysis.
{ # Defines the file to exclude from Advanced malware sandbox inline ML analysis.
"filename": "A String", # Optional. Name of the file to exclude from Advanced malware sandbox inline ML analysis.
"partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from Advanced malware sandbox inline ML analysis.
},
],
"inlineMlConfigs": [ # Optional. List of inline ML configurations to enable in Advanced malware sandbox inline ML analysis.
{ # Configuration for Advanced malware sandbox inline ML analysis per file type.
"action": "A String", # Required. Action to take when a threat is detected using inline ML.
"fileType": "A String", # Required. File type to configure inline ML for.
},
],
},
],
"wildfireOverrides": [ # Optional. Configuration for overriding Advanced malware sandbox actions per protocol.
{ # Defines what action to take for Advanced malware sandbox threats per protocol.
"action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
"protocol": "A String", # Required. Protocol to match.
},
],
"wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the Advanced malware sandbox real-time signature cloud performs a signature lookup. The default value is `false`.
"wildfireSubmissionRules": [ # Optional. Configurations for Advanced malware sandbox (WildFire) file submissions.
{ # Defines the file types to be submitted for Advanced malware sandbox analysis and the direction of the traffic.
"customFileTypes": { # The options to submit a custom list of file types for scanning. # Submit a custom list of file types for Advanced malware sandbox analysis.
"fileTypes": [ # Required. File types to be submitted for Advanced malware sandbox analysis.
"A String",
],
},
"direction": "A String", # Required. Direction for the files to be analyzed by Advanced malware sandbox.
"fileSelectionMode": "A String", # Required. File selection mode for Advanced malware sandbox analysis.
},
],
"wildfireThreatOverrides": [ # Optional. Configuration for overriding the Advanced malware sandbox threat action by `threat_id` match.
{ # Defines what action to take for a specific Advanced malware sandbox `threat_id` match.
"action": "A String", # Required. Threat action override.
"threatId": "A String", # Required. Threat ID to match.
},
],
},
}
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `SecurityProfile` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}