Microsoft.Security (preview:2024-08-01)

2024/12/05 • 6 new methods

SecurityConnectors_List (new)
Description :  Lists all the security connectors in the specified subscription. Use the 'nextLink' property in the response to get the next page of security connectors for the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Security/securityConnectors
{
api-version:
{
Description: API version for the operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of security connectors under the given scope. ,
Required: True ,
}
[
{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityConnectors_ListByResourceGroup (new)
Description :  Lists all the security connectors in the specified resource group. Use the 'nextLink' property in the response to get the next page of security connectors for the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors
{
api-version:
{
Description: API version for the operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of security connectors under the given scope. ,
Required: True ,
}
[
{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityConnectors_Get (new)
Description :  Retrieves details of a specific security connector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}
{
api-version:
{
Description: API version for the operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
securityConnectorName:
{
Description: The security connector name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityConnectors_CreateOrUpdate (new)
Description :  Creates or updates a security connector. If a security connector is already created and a subsequent request is issued for the same security connector id, then it will be updated.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}
{
api-version:
{
Description: API version for the operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
securityConnectorName:
{
Description: The security connector name. ,
Required: True ,
}
string ,
securityConnector:
{
Description: The security connector resource ,
Required: True ,
}
{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityConnectors_Update (new)
Description :  Updates a security connector
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}
{
api-version:
{
Description: API version for the operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
securityConnectorName:
{
Description: The security connector name. ,
Required: True ,
}
string ,
securityConnector:
{
Description: The security connector resource ,
Required: True ,
}
{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Security connector data ,
Required: False ,
}
{
hierarchyIdentifier:
{
Description: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). ,
Required: False ,
}
string ,
hierarchyIdentifierTrialEndDate:
{
Description: The date on which the trial period will end, if applicable. Trial period exists for 30 days after upgrading to payed offerings. ,
Format: date-time ,
Required: False ,
}
string ,
environmentName:
{
Description: The multi cloud resource's cloud name. ,
Enum:
{
Azure: No description available. ,
AWS: No description available. ,
GCP: No description available. ,
Github: No description available. ,
AzureDevOps: No description available. ,
GitLab: No description available. ,
DockerHub: No description available. ,
JFrog: No description available. ,
}
,
Required: False ,
}
enum ,
offerings:
{
Description: A collection of offerings for the security connector. ,
Required: False ,
}
[
{
offeringType:
{
Description: The type of the security offering. ,
Enum:
{
CspmMonitorAws: No description available. ,
DefenderForContainersAws: No description available. ,
DefenderForServersAws: No description available. ,
DefenderForDatabasesAws: No description available. ,
CspmMonitorGcp: No description available. ,
CspmMonitorGithub: No description available. ,
CspmMonitorAzureDevOps: No description available. ,
DefenderForServersGcp: No description available. ,
DefenderForContainersGcp: No description available. ,
DefenderForDatabasesGcp: No description available. ,
DefenderCspmAws: No description available. ,
DefenderCspmGcp: No description available. ,
CspmMonitorGitLab: No description available. ,
CspmMonitorDockerHub: No description available. ,
DefenderForContainersDockerHub: No description available. ,
DefenderCspmDockerHub: No description available. ,
CspmMonitorJFrog: No description available. ,
DefenderForContainersJFrog: No description available. ,
DefenderCspmJFrog: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The offering description. ,
Required: False ,
}
string ,
}
,
]
,
environmentData:
{
Description: The security connector environment data. ,
Required: False ,
}
{
environmentType:
{
Description: The type of the environment data. ,
Enum:
{
AwsAccount: No description available. ,
GcpProject: No description available. ,
GithubScope: No description available. ,
AzureDevOpsScope: No description available. ,
GitlabScope: No description available. ,
DockerHubOrganization: No description available. ,
JFrogArtifactory: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityConnectors_Delete (new)
Description :  Deletes a security connector.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}
{
api-version:
{
Description: API version for the operation ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure subscription ID ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
securityConnectorName:
{
Description: The security connector name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}