azure-native.securityinsights.SentinelOnboardingState
Explore with Pulumi AI
Sentinel onboarding state
Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native securityinsights [ApiVersion]
. See the version guide for details.
Create SentinelOnboardingState Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SentinelOnboardingState(name: string, args: SentinelOnboardingStateArgs, opts?: CustomResourceOptions);
@overload
def SentinelOnboardingState(resource_name: str,
args: SentinelOnboardingStateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SentinelOnboardingState(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
workspace_name: Optional[str] = None,
customer_managed_key: Optional[bool] = None,
sentinel_onboarding_state_name: Optional[str] = None)
func NewSentinelOnboardingState(ctx *Context, name string, args SentinelOnboardingStateArgs, opts ...ResourceOption) (*SentinelOnboardingState, error)
public SentinelOnboardingState(string name, SentinelOnboardingStateArgs args, CustomResourceOptions? opts = null)
public SentinelOnboardingState(String name, SentinelOnboardingStateArgs args)
public SentinelOnboardingState(String name, SentinelOnboardingStateArgs args, CustomResourceOptions options)
type: azure-native:securityinsights:SentinelOnboardingState
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SentinelOnboardingStateArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. SentinelOnboardingStateArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SentinelOnboardingStateArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SentinelOnboardingStateArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SentinelOnboardingStateArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var sentinelOnboardingStateResource = new AzureNative.SecurityInsights.SentinelOnboardingState("sentinelOnboardingStateResource", new()
{
ResourceGroupName = "string",
WorkspaceName = "string",
CustomerManagedKey = false,
SentinelOnboardingStateName = "string",
});
example, err := securityinsights.NewSentinelOnboardingState(ctx, "sentinelOnboardingStateResource", &securityinsights.SentinelOnboardingStateArgs{
ResourceGroupName: pulumi.String("string"),
WorkspaceName: pulumi.String("string"),
CustomerManagedKey: pulumi.Bool(false),
SentinelOnboardingStateName: pulumi.String("string"),
})
var sentinelOnboardingStateResource = new SentinelOnboardingState("sentinelOnboardingStateResource", SentinelOnboardingStateArgs.builder()
.resourceGroupName("string")
.workspaceName("string")
.customerManagedKey(false)
.sentinelOnboardingStateName("string")
.build());
sentinel_onboarding_state_resource = azure_native.securityinsights.SentinelOnboardingState("sentinelOnboardingStateResource",
resource_group_name="string",
workspace_name="string",
customer_managed_key=False,
sentinel_onboarding_state_name="string")
const sentinelOnboardingStateResource = new azure_native.securityinsights.SentinelOnboardingState("sentinelOnboardingStateResource", {
resourceGroupName: "string",
workspaceName: "string",
customerManagedKey: false,
sentinelOnboardingStateName: "string",
});
type: azure-native:securityinsights:SentinelOnboardingState
properties:
customerManagedKey: false
resourceGroupName: string
sentinelOnboardingStateName: string
workspaceName: string
SentinelOnboardingState Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SentinelOnboardingState resource accepts the following input properties:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Customer
Managed boolKey - Flag that indicates the status of the CMK setting
- Sentinel
Onboarding State Name Changes to this property will trigger replacement.
- The Sentinel onboarding state name. Supports - default
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Customer
Managed boolKey - Flag that indicates the status of the CMK setting
- Sentinel
Onboarding State Name Changes to this property will trigger replacement.
- The Sentinel onboarding state name. Supports - default
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- customer
Managed BooleanKey - Flag that indicates the status of the CMK setting
- sentinel
Onboarding State Name Changes to this property will trigger replacement.
- The Sentinel onboarding state name. Supports - default
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- customer
Managed booleanKey - Flag that indicates the status of the CMK setting
- sentinel
Onboarding State Name Changes to this property will trigger replacement.
- The Sentinel onboarding state name. Supports - default
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- customer_
managed_ boolkey - Flag that indicates the status of the CMK setting
- sentinel_
onboarding_ state_ name Changes to this property will trigger replacement.
- The Sentinel onboarding state name. Supports - default
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- customer
Managed BooleanKey - Flag that indicates the status of the CMK setting
- sentinel
Onboarding State Name Changes to this property will trigger replacement.
- The Sentinel onboarding state name. Supports - default
Outputs
All input properties are implicitly available as output properties. Additionally, the SentinelOnboardingState resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Security Insights. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Etag string
- Etag of the azure resource
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Etag string
- Etag of the azure resource
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag String
- Etag of the azure resource
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag string
- Etag of the azure resource
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag str
- Etag of the azure resource
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag String
- Etag of the azure resource
Supporting Types
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:securityinsights:SentinelOnboardingState default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0