Azure
This Integration is part of the Azure Pack.#
Supported versions
Available on Cortex XSOAR (versions 8.11.0 and later) and Cortex XSIAM.
Cloud integrations are installed from the Data Sources page. To configure a cloud integration, go to Settings > Data Sources, click Add Data Source, and select Microsoft Azure. Click Connect, then click Show advanced settings, and under Additional Security Capabilities, enable Automation.
Configure Azure in Cortex#
| Parameter | Description | Required |
|---|---|---|
| Application ID | ||
| Default Subscription ID | You can set the value either in the configuration or directly within the commands. If you set it in both places, the value in the command will override the configuration setting. | True |
| Default Resource Group Name | You can set the value either in the configuration or directly within the commands. If you set it in both places, the value in the command will override the configuration setting. | |
| Azure AD endpoint | Azure AD endpoint associated with a national cloud. | False |
| Authentication Type | The type of authentication. Can be Client Credentials (default authentication type), Device Code, Authorization Code, or Azure Managed Identities. | False |
| Trust any certificate (not secure) | False | |
| Use system proxy settings | False | |
| Tenant ID | The tenant ID of the Azure app registration. | False |
| Client Secret | The client secret of the Azure app registration. Required when using the Client Credentials flow. | False |
| Application redirect URI | The application redirect URI for the Authorization Code flow. | False |
| Authorization code | The authorization code for the Authorization Code flow, received from the authorization step. See the Detailed Instructions (?) section. | False |
| Azure Managed Identities Client ID | The managed identities client ID for authentication. Relevant only when the integration is running on an Azure VM. | False |
Commands#
You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
azure-nsg-security-rule-update#
Update a security rule. If one does not exist, it will be created. The command is deprecated, please use azure-vn-security-rule-update. Required Permissions: Microsoft.Network/networkSecurityGroups/securityRules/read, Microsoft.Network/networkSecurityGroups/securityRules/write.
Base Command#
azure-nsg-security-rule-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The name of the resource group. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to be updated. | Required |
| direction | The direction of the rule. Possible values are: "Inbound" and "Outbound". Possible values are: Inbound, Outbound. | Optional |
| action | Whether to allow the traffic. Possible values are "Allow" and "Deny". Possible values are: Allow, Deny. | Optional |
| protocol | The protocol on which to apply the rule. Possible values are: "Any", "TCP", "UDP", and "ICMP". Possible values are: Any, TCP, UDP, ICMP. | Optional |
| source | The source IP address range from which incoming traffic will be allowed or denied by this rule. Possible values are "Any", an IP address range, an application security group, or a default tag. Default is "Any". | Optional |
| priority | The priority by which the rules will be processed. The lower the number, the higher the priority. We recommend leaving gaps between rules - 100, 200, 300, etc. - so that it is easier to add new rules without having to edit existing rules. Default is "4096". | Optional |
| source_ports | The source ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk () to allow traffic on any port. Default is "". | Optional |
| destination | The destination IP address range for outgoing traffic that is allowed or denied by this rule. The destination filter can be "Any", an IP address range, an application security group, or a default tag. | Optional |
| destination_ports | The destination ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk (*) to allow traffic on any port. | Optional |
| description | A description to add to the rule. | Optional |
| access | The network traffic is allowed or denied. Possible values are: Allow, Deny. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGRule.name | String | The rule's name. |
| Azure.NSGRule.id | String | The rule's ID. |
| Azure.NSGRule.etag | String | The rule's ETag. |
| Azure.NSGRule.type | String | The rule's type. |
| Azure.NSGRule.provisioningState | String | The rule's provisioning state. |
| Azure.NSGRule.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.NSGRule.sourcePortRange | String | For a single port, the source port or a range of ports. |
| Azure.NSGRule.sourcePortRanges | String | For multiple ports, a list of these ports. |
| Azure.NSGRule.destinationPortRange | String | For a single port, the destination port or range of ports. |
| Azure.NSGRule.destinationPortRanges | String | For multiple ports, a list of destination ports. |
| Azure.NSGRule.sourceAddressPrefix | String | The source address. |
| Azure.NSGRule.destinationAddressPrefix | String | The destination address. |
| Azure.NSGRule.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.NSGRule.priority | Number | The rule's priority. Can be from 100 to 4096. |
| Azure.NSGRule.direction | String | The rule's direction. Can be "Inbound" or "Outbound". |
azure-storage-accounts-list#
Lists storage accounts, or retrieves a single storage account when an account name is provided. Required permission: Microsoft.Storage/storageAccounts/read.
Base Command#
azure-storage-accounts-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The storage account name. When provided, retrieves the specified storage account only; otherwise all storage accounts in the resource group are listed. | Optional |
| next_token | A token for retrieving the next page of results, returned by a previous call to this command. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.StorageAccounts.id | String | The fully qualified resource ID of the storage account. |
| Azure.Storage.StorageAccounts.name | String | The name of the storage account. |
| Azure.Storage.StorageAccounts.type | String | The resource type. |
| Azure.Storage.StorageAccounts.location | String | The geo-location where the resource lives. |
| Azure.Storage.StorageAccounts.kind | String | The kind of the storage account. |
| Azure.Storage.StorageAccounts.tags | Unknown | The resource tags. |
| Azure.Storage.StorageAccounts.identity | Unknown | The identity of the resource. |
| Azure.Storage.StorageAccounts.extendedLocation | Unknown | The extended location of the resource. |
| Azure.Storage.StorageAccounts.placement | Unknown | The zonal placement details for the storage account. |
| Azure.Storage.StorageAccounts.zones | Unknown | The availability zones. |
| Azure.Storage.StorageAccounts.sku | Unknown | The SKU of the storage account. |
| Azure.Storage.StorageAccounts.systemData | Unknown | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| Azure.Storage.StorageAccounts.properties.provisioningState | String | The status of the storage account when the operation was called. |
| Azure.Storage.StorageAccounts.properties.primaryLocation | String | The location of the primary data center for the storage account. |
| Azure.Storage.StorageAccounts.properties.secondaryLocation | String | The location of the geo-replicated secondary for the storage account. Only available if the account type is Standard_GRS or Standard_RAGRS. |
| Azure.Storage.StorageAccounts.properties.statusOfPrimary | String | The status indicating whether the primary location of the storage account is available or unavailable. |
| Azure.Storage.StorageAccounts.properties.statusOfSecondary | String | The status indicating whether the secondary location of the storage account is available or unavailable. |
| Azure.Storage.StorageAccounts.properties.lastGeoFailoverTime | Date | The timestamp of the most recent instance of a failover to the secondary location. |
| Azure.Storage.StorageAccounts.properties.creationTime | Date | The creation date and time of the storage account, in UTC. |
| Azure.Storage.StorageAccounts.properties.primaryEndpoints | Unknown | The URLs used to retrieve a public blob, queue, or table object from the primary location. |
| Azure.Storage.StorageAccounts.properties.secondaryEndpoints | Unknown | The URLs used to retrieve a public blob, queue, or table object from the secondary location. Only available if the SKU name is Standard_RAGRS. |
| Azure.Storage.StorageAccounts.properties.customDomain | Unknown | The custom domain the user assigned to the storage account. |
| Azure.Storage.StorageAccounts.properties.accessTier | String | The access tier for billing, used by BlobStorage accounts. |
| Azure.Storage.StorageAccounts.properties.supportsHttpsTrafficOnly | Boolean | Whether the storage account allows only HTTPS traffic. |
| Azure.Storage.StorageAccounts.properties.minimumTlsVersion | String | The minimum TLS version permitted on requests to storage. |
| Azure.Storage.StorageAccounts.properties.allowBlobPublicAccess | Boolean | Whether public access to all blobs or containers in the storage account is permitted. |
| Azure.Storage.StorageAccounts.properties.allowSharedKeyAccess | Boolean | Whether the storage account permits requests to be authorized with the account access key via Shared Key. |
| Azure.Storage.StorageAccounts.properties.allowSharedKeyAccessForServices | Unknown | The shared key access properties at the service level. |
| Azure.Storage.StorageAccounts.properties.allowCrossTenantReplication | Boolean | Whether cross AAD tenant object replication is allowed. |
| Azure.Storage.StorageAccounts.properties.allowCrossTenantDelegationSas | Boolean | Whether cross AAD tenant user delegation SAS is allowed. |
| Azure.Storage.StorageAccounts.properties.allowedCopyScope | String | Restricts copy to and from storage accounts within an AAD tenant or with Private Links to the same VNet. |
| Azure.Storage.StorageAccounts.properties.defaultToOAuthAuthentication | Boolean | Whether the default authentication is OAuth. |
| Azure.Storage.StorageAccounts.properties.publicNetworkAccess | String | Whether public network access to the storage account is allowed. |
| Azure.Storage.StorageAccounts.properties.networkAcls | Unknown | The network rule set of the storage account. |
| Azure.Storage.StorageAccounts.properties.encryption | Unknown | The encryption settings used for server-side encryption for the storage account. |
| Azure.Storage.StorageAccounts.properties.keyCreationTime | Unknown | The creation date and time of the storage account keys. |
| Azure.Storage.StorageAccounts.properties.keyPolicy | Unknown | The KeyPolicy assigned to the storage account. |
| Azure.Storage.StorageAccounts.properties.sasPolicy | Unknown | The SasPolicy assigned to the storage account. |
| Azure.Storage.StorageAccounts.properties.privateEndpointConnections | Unknown | The list of private endpoint connections associated with the storage account. |
| Azure.Storage.StorageAccounts.properties.routingPreference | Unknown | The network routing choice opted by the user for data transfer. |
| Azure.Storage.StorageAccounts.properties.blobRestoreStatus | Unknown | The blob restore status. |
| Azure.Storage.StorageAccounts.properties.geoReplicationStats | Unknown | The geo replication stats. |
| Azure.Storage.StorageAccounts.properties.geoPriorityReplicationStatus | String | The status indicating whether Geo Priority Replication is enabled for the account. |
| Azure.Storage.StorageAccounts.properties.failoverInProgress | Boolean | Whether a failover is in progress. |
| Azure.Storage.StorageAccounts.properties.accountMigrationInProgress | Boolean | Whether a customer-initiated account migration is in progress. |
| Azure.Storage.StorageAccounts.properties.isSkuConversionBlocked | Boolean | Whether the SKU conversion is blocked during an ongoing migration. |
| Azure.Storage.StorageAccounts.properties.storageAccountSkuConversionStatus | Unknown | The storage account SKU conversion status. |
| Azure.Storage.StorageAccounts.properties.isHnsEnabled | Boolean | Whether the account HierarchicalNamespace is enabled. |
| Azure.Storage.StorageAccounts.properties.isNfsV3Enabled | Boolean | Whether NFS 3.0 protocol support is enabled. |
| Azure.Storage.StorageAccounts.properties.isSftpEnabled | Boolean | Whether Secure File Transfer Protocol is enabled. |
| Azure.Storage.StorageAccounts.properties.isLocalUserEnabled | Boolean | Whether the local users feature is enabled. |
| Azure.Storage.StorageAccounts.properties.enableExtendedGroups | Boolean | Whether extended group support with the local users feature is enabled. |
| Azure.Storage.StorageAccounts.properties.largeFileSharesState | String | Whether large file shares are allowed. |
| Azure.Storage.StorageAccounts.properties.azureFilesIdentityBasedAuthentication | Unknown | The identity-based authentication settings for Azure Files. |
| Azure.Storage.StorageAccounts.properties.immutableStorageWithVersioning | Unknown | The account-level object immutability property. |
| Azure.Storage.StorageAccounts.properties.dnsEndpointType | String | The type of endpoint for the storage account. |
| Azure.Storage.StorageAccounts.properties.dualStackEndpointPreference | Unknown | Information about the internet protocol opted by the user. |
| Azure.Storage.StorageAccounts.properties.dataCollaborationPolicyProperties | Unknown | The data collaboration policy for the storage account. |
| Azure.Storage.StorageAccountsNextToken | String | A token for retrieving the next page of storage accounts. Pass it as the next_token argument in a subsequent call. |
azure-storage-blob-containers-list#
Lists blob containers, or retrieves a single blob container when a container name is provided. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/read.
Base Command#
azure-storage-blob-containers-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The storage account name. | Required |
| container_name | The container name. When provided, retrieves the specified container only; otherwise all containers in the storage account are listed. | Optional |
| include_deleted | Whether to include soft-deleted blob containers in the response. Possible values are: true, false. | Optional |
| limit | The maximum number of containers to return (1-5000). | Optional |
| next_token | A token for retrieving the next page of results, returned by a previous call to this command. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.BlobContainers.id | String | The fully qualified resource ID of the resource. |
| Azure.Storage.BlobContainers.name | String | The name of the resource. |
| Azure.Storage.BlobContainers.type | String | The resource type. |
| Azure.Storage.BlobContainers.etag | String | The resource etag. |
| Azure.Storage.BlobContainers.properties.version | String | The version of the deleted blob container. |
| Azure.Storage.BlobContainers.properties.deleted | Boolean | Whether the blob container was deleted. |
| Azure.Storage.BlobContainers.properties.deletedTime | Date | The date and time when the blob container was deleted. |
| Azure.Storage.BlobContainers.properties.remainingRetentionDays | Number | The number of remaining days after which the blob container is permanently deleted. |
| Azure.Storage.BlobContainers.properties.defaultEncryptionScope | String | The default encryption scope to use for blob operations in the container. |
| Azure.Storage.BlobContainers.properties.denyEncryptionScopeOverride | Boolean | Whether to block the override of the encryption scope from the container default. |
| Azure.Storage.BlobContainers.properties.publicAccess | String | The access level, which specifies whether data in the container can be accessed publicly. |
| Azure.Storage.BlobContainers.properties.lastModifiedTime | Date | The date and time when the container was last modified, in ISO 8601 format (for example, 2024-01-15T12:34:56Z). |
| Azure.Storage.BlobContainers.properties.leaseStatus | String | The lease status of the container. |
| Azure.Storage.BlobContainers.properties.leaseState | String | The lease state of the container. |
| Azure.Storage.BlobContainers.properties.leaseDuration | String | The duration of the lease, specified whether the lease is of infinite or fixed duration, only when the container is leased. |
| Azure.Storage.BlobContainers.properties.metadata | Unknown | A name-value pair to associate with the container as metadata. |
| Azure.Storage.BlobContainers.properties.immutabilityPolicy | Unknown | The ImmutabilityPolicy property of the container. |
| Azure.Storage.BlobContainers.properties.legalHold | Unknown | The LegalHold property of the container. |
| Azure.Storage.BlobContainers.properties.hasLegalHold | Boolean | Whether at least one legal hold tag exists for the container. |
| Azure.Storage.BlobContainers.properties.hasImmutabilityPolicy | Boolean | Whether an ImmutabilityPolicy exists for the container. |
| Azure.Storage.BlobContainers.properties.immutableStorageWithVersioning | Unknown | The object level immutability property of the container. |
| Azure.Storage.BlobContainers.properties.enableNfsV3RootSquash | Boolean | Whether NFSv3 root squash is enabled for the container. |
| Azure.Storage.BlobContainers.properties.enableNfsV3AllSquash | Boolean | Whether NFSv3 all squash is enabled for the container. |
| Azure.Storage.BlobContainers.systemData | Unknown | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| Azure.Storage.BlobContainersNextToken | String | A token for retrieving the next page of blob containers. Pass it as the next_token argument in a subsequent call. |
azure-storage-account-update#
Updates a specific account storage. Required permissions: Microsoft.Storage/storageAccounts/read, Microsoft.Storage/storageAccounts/write.
Base Command#
azure-storage-account-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| sku | Gets or sets the SKU name, Required for account creation; optional for update. Possible values are: Premium_LRS, Premium_ZRS, Standard_GRS, Standard_GZRS, Standard_LRS, Standard_RAGRS, Standard_RAGZRS, Standard_ZRS. | Optional |
| kind | Indicates the type of storage account, Required for account creation; optional for update. Possible values are: Storage, StorageV2, BlobStorage, FileStorage, BlockBlobStorage. | Optional |
| location | Gets or sets the location of the resource. The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. Required for account creation; optional for update. Possible values are: eastus, eastus2, westus, westeurope, eastasia, southeastasia, japaneast, japanwest, northcentralus, southcentralus, centralus, northeurope, brazilsouth, australiaeast, australiasoutheast, southindia, centralindia, westindia, canadaeast, canadacentral, westus2, westcentralus, uksouth, ukwest, koreacentral, koreasouth, francecentral, australiacentral, southafricanorth, uaenorth, switzerlandnorth, germanywestcentral, norwayeast. | Optional |
| tags | Gets or sets a list of tags that describe the resource. | Optional |
| custom_domain_name | Gets or sets the custom domain name assigned to the storage account. | Optional |
| use_sub_domain_name | Indicates whether indirect CName validation is enabled. Possible values are: true, false. | Optional |
| enc_key_source | The encryption keySource. Possible values are: Microsoft.Storage, Microsoft.Keyvault. | Optional |
| enc_requireInfrastructureEncryption | Indicates whether the service applies a secondary layer of encryption with platform managed keys for data at rest. Possible values are: true, false. | Optional |
| enc_keyvault_key_name | The name of KeyVault key. | Optional |
| enc_keyvault_key_version | The version of KeyVault key. | Optional |
| enc_keyvault_uri | The Uri of KeyVault. | Optional |
| access_tier | The access tier for the account. Required where kind = BlobStorage. Possible values are: Hot, Cool. | Optional |
| supports_https_traffic_only | Allows https traffic only to storage service if sets to true. Possible values are: true, false. | Optional |
| is_hns_enabled | Account HierarchicalNamespace enabled if sets to true. Possible values are: true, false. | Optional |
| large_file_shares_state | If set to Enabled, allows large file shares. Possible values are: Disabled, Enabled. | Optional |
| allow_blob_public_access | If set to true, allows public access to all blobs or containers in the storage account. Possible values are: true, false. | Optional |
| minimum_tls_version | Sets the minimum TLS version to be permitted on requests to storage. Possible values are: TLS1_0, TLS1_1, TLS1_2. | Optional |
| network_ruleset_bypass | Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are: AzureServices, Logging, Metrics, None. | Optional |
| network_ruleset_default_action | Specifies the default action of allow or deny when no other rules match. Possible values are: Allow, Deny. | Optional |
| network_ruleset_ipRules | Sets the IP ACL rules. | Optional |
| virtual_network_rules | Sets the virtual network rules. | Optional |
| allow_cross_tenant_replication | Allow or disallow cross AAD tenant object replication. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.StorageAccounts.id | String | Fully qualified resource ID for the resource. |
| Azure.Storage.StorageAccounts.kind | String | The kind of storage account. |
| Azure.Storage.StorageAccounts.location | String | The geo-location where the resource lives. |
| Azure.Storage.StorageAccounts.name | String | The name of the resource. |
| Azure.Storage.StorageAccounts.properties.isHnsEnabled | Boolean | Account HierarchicalNamespace enabled if sets to true. |
| Azure.Storage.StorageAccounts.properties.allowBlobPublicAccess | Boolean | If set to true (default), allows public access to all blobs or containers in the storage account. |
| Azure.Storage.StorageAccounts.properties.minimumTlsVersion | String | The minimum TLS version to be permitted on requests to storage. Default is TLS 1.0. |
| Azure.Storage.StorageAccounts.properties.allowSharedKeyAccess | Boolean | Whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests (including shared access signatures) must be authorized with Azure Active Directory (Azure AD). |
| Azure.Storage.StorageAccounts.properties.creationTime | Date | The creation date and time of the storage account in UTC. |
| Azure.Storage.StorageAccounts.properties.primaryEndpoints | String | The URLs that are used to retrieve a public blob, queue, or table object. |
| Azure.Storage.StorageAccounts.properties.primaryLocation | String | The storage account primary data center location. |
| Azure.Storage.StorageAccounts.properties.provisioningState | String | The status of the storage account at the time the operation was called. |
| Azure.Storage.StorageAccounts.properties.routingPreference.routingChoice | String | The kind of network routing the user chose. |
| Azure.Storage.StorageAccounts.properties.routingPreference.publishMicrosoftEndpoints | Boolean | Whether Microsoft routing storage endpoints are to be published. |
| Azure.Storage.StorageAccounts.properties.routingPreference.publishInternetEndpoints | Boolean | Whether internet routing storage endpoints are to be published. |
| Azure.Storage.StorageAccounts.properties.encryption | String | Encryption settings to be used for server-side encryption for the storage account. |
| Azure.Storage.StorageAccounts.properties.secondaryLocation | String | The geo-replicated secondary location for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. |
| Azure.Storage.StorageAccounts.properties.statusOfPrimary | String | Whether the storage account primary location is available or unavailable. |
| Azure.Storage.StorageAccounts.properties.statusOfSecondary | String | Whether the storage account secondary location is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. |
| Azure.Storage.StorageAccounts.properties.supportsHttpsTrafficOnly | Boolean | If set to true, allows https traffic only to storage service. |
| Azure.Storage.StorageAccounts.sku.name | String | The SKU name. Required for account creation; optional for update. |
| Azure.Storage.StorageAccounts.sku.tier | String | The SKU tier. This is based on the SKU name. |
| Azure.Storage.StorageAccounts.tags | unknown | Resource tags. |
| Azure.Storage.StorageAccounts.type | String | The storage account type. |
azure-storage-blob-service-properties-set#
Sets properties for the blob service in a specific account storage. The command is deprecated, please use azure-storage-blob-service-property-set. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/read, Microsoft.Storage/storageAccounts/blobServices/write.
Base Command#
azure-storage-blob-service-properties-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The subscription ID. | Required |
| account_name | The name of the storage account. | Required |
| delete_rentention_policy_enabled | Whether DeleteRetentionPolicy is enabled. Possible values are: true, false. | Optional |
| delete_rentention_policy_days | The number of days the deleted item should be retained. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.StorageAccountBlobServiceProperties.id | String | The resource ID. |
| Azure.StorageAccountBlobServiceProperties.name | String | The name of the resource. |
| Azure.StorageAccountBlobServiceProperties.type | String | The type of the resource. |
| Azure.StorageAccountBlobServiceProperties.properties.cors | String | Specifies CORS rules for the Blob service. |
| Azure.StorageAccountBlobServiceProperties.properties.defaultServiceVersion | Date | The default version for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
| Azure.StorageAccountBlobServiceProperties.properties.deleteRetentionPolicy | unknown | The service properties for soft delete. |
| Azure.StorageAccountBlobServiceProperties.properties.isVersioningEnabled | Boolean | If set to true, enables versioning. |
| Azure.StorageAccountBlobServiceProperties.properties.changeFeed | unknown | The blob service properties for change feed events. |
| Azure.StorageAccountBlobServiceProperties.sku.name | String | The SKU name. |
| Azure.StorageAccountBlobServiceProperties.sku.tier | String | The SKU tier. |
azure-policy-assignment-create#
Creates a policy assignment. Required permissions: Microsoft.Authorization/policyAssignments/read, Microsoft.Authorization/policyAssignments/write.
Base Command#
azure-policy-assignment-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| name | Name of the policy assignment. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| scope | The scope of the policy assignment. | Required |
| policy_definition_id | The ID of the policy definition or policy set definition being assigned. | Optional |
| display_name | The assignment display name. | Optional |
| parameters | The JSON object for policy properties parameters and their values. | Optional |
| description | This message will be part of the response in case of policy violation. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Policy.PolicyAssignments.ID | string | The resource ID of the policy assignment. |
| Azure.Policy.PolicyAssignments.Name | string | The name of the policy assignment. |
| Azure.Policy.PolicyAssignments.Type | string | The type of the resource (e.g., 'Microsoft.Authorization/policyAssignments'). |
| Azure.Policy.PolicyAssignments.Location | string | The location of the policy assignment. |
| Azure.Policy.PolicyAssignments.Identity | unknown | The managed identity associated with the policy assignment. |
| Azure.Policy.PolicyAssignments.Properties.DisplayName | string | The display name of the policy assignment. |
| Azure.Policy.PolicyAssignments.Properties.Description | string | The description of the policy assignment. |
| Azure.Policy.PolicyAssignments.Properties.PolicyDefinitionId | string | The ID of the policy definition or policy set definition being assigned. |
| Azure.Policy.PolicyAssignments.Properties.Scope | string | The scope of the policy assignment. |
| Azure.Policy.PolicyAssignments.Properties.NotScopes | unknown | The list of scopes that are excluded from the policy assignment. |
| Azure.Policy.PolicyAssignments.Properties.Parameters | unknown | The parameter values for the assigned policy rule. |
| Azure.Policy.PolicyAssignments.Properties.Metadata | unknown | The metadata associated with the policy assignment. |
| Azure.Policy.PolicyAssignments.Properties.EnforcementMode | string | The policy assignment enforcement mode (e.g., 'Default' or 'DoNotEnforce'). |
| Azure.Policy.PolicyAssignments.Properties.latestDefinitionVersion | string | The latest version of the policy definition available. This is only present if requested via the $expand query parameter. |
| Azure.Policy.PolicyAssignments.Properties.NonComplianceMessages | unknown | The messages that describe why a resource is non-compliant with the policy. |
| Azure.Policy.PolicyAssignments.Properties.DefinitionVersion | string | The version of the policy definition to use. |
| Azure.Policy.PolicyAssignments.Properties.Overrides | unknown | The policy property value overrides. |
| Azure.Policy.PolicyAssignments.Properties.ResourceSelectors | unknown | The resource selectors to filter policies by resource properties. |
| Azure.Policy.PolicyAssignments.SystemData | unknown | The system metadata relating to this resource. |
azure-postgres-config-set#
Updates a configuration of a server. The command is deprecated due to the retirement of Azure PostgreSQL Single Server.
Base Command#
azure-postgres-config-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| server_name | Name of the PostgreSQL server. | Required |
| configuration_name | The configuration setting name. | Required |
| subscription_id | Subscription ID. | Optional |
| source | Source of the configuration. | Optional |
| value | Value of the configuration. | Optional |
Context Output#
There is no context output for this command.
azure-webapp-config-set#
Updates the configuration settings of an existing Azure Web App. The command is deprecated, please use azure-appservice-webapp-config-update. Required Permissions: Microsoft.Web/sites/config/read, Microsoft.Web/sites/config/write.
Base Command#
azure-webapp-config-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| subscription_id | Subscription ID. | Optional |
| name | Name of the Web App. | Required |
| http20_enabled | Configures a web site to allow clients to connect over http2.0. Possible values are: true, false. | Optional |
| remote_debugging_enabled | True if remote debugging is enabled; otherwise, false. Possible values are: true, false. | Optional |
| min_tls_version | Configures the minimum version of TLS required for SSL requests. Possible values are: 1.0, 1.1, 1.2, 1.3. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.WebAppConfig.id | String | Resource ID. |
| Azure.WebAppConfig.name | String | Resource name. |
| Azure.WebAppConfig.type | String | Resource type. |
| Azure.WebAppConfig.location | String | Resource location. |
| Azure.WebAppConfig.properties.numberOfWorkers | Number | Number of workers. |
| Azure.WebAppConfig.properties.defaultDocuments | Unknown | List of default documents. |
| Azure.WebAppConfig.properties.netFrameworkVersion | String | .NET Framework version. |
| Azure.WebAppConfig.properties.phpVersion | String | PHP version. |
| Azure.WebAppConfig.properties.pythonVersion | String | Python version. |
| Azure.WebAppConfig.properties.nodeVersion | String | Node.js version. |
| Azure.WebAppConfig.properties.powerShellVersion | String | PowerShell version. |
| Azure.WebAppConfig.properties.linuxFxVersion | String | Linux app framework and version. |
| Azure.WebAppConfig.properties.windowsFxVersion | String | Windows container image name. |
| Azure.WebAppConfig.properties.requestTracingEnabled | Boolean | Indicates whether request tracing is enabled. |
| Azure.WebAppConfig.properties.remoteDebuggingEnabled | Boolean | Indicates whether remote debugging is enabled. |
| Azure.WebAppConfig.properties.remoteDebuggingVersion | String | Remote debugging version. |
| Azure.WebAppConfig.properties.http20Enabled | Boolean | Indicates whether HTTP/2 is enabled. |
| Azure.WebAppConfig.properties.minTlsVersion | String | Minimum TLS version required. |
| Azure.WebAppConfig.properties.ftpsState | String | State of FTP / FTPS service. |
| Azure.WebAppConfig.properties.webSocketsEnabled | Boolean | Indicates whether WebSockets are enabled. |
| Azure.WebAppConfig.properties.alwaysOn | Boolean | Indicates whether Always On is enabled. |
| Azure.WebAppConfig.properties.managedPipelineMode | String | Managed pipeline mode. |
| Azure.WebAppConfig.properties.loadBalancing | String | Site load balancing mode. |
| Azure.WebAppConfig.properties.autoHealEnabled | Boolean | Indicates whether Auto Heal is enabled. |
| Azure.WebAppConfig.properties.autoHealRules | Unknown | Auto Heal rules configuration. |
| Azure.WebAppConfig.properties.cors.allowedOrigins | Unknown | CORS allowed origins. |
| Azure.WebAppConfig.properties.cors.supportCredentials | Boolean | Indicates whether CORS supports credentials. |
| Azure.WebAppConfig.properties.apiDefinition.url | String | URL of the API definition. |
| Azure.WebAppConfig.properties.apiManagementConfig.id | String | Azure API management integration ID. |
azure-webapp-auth-update#
Updates the authentication and authorization settings of an existing Azure Web App. The command is deprecated, please use azure-appservice-webapp-auth-settings-update. Required Permissions: Microsoft.Web/sites/config/read, Microsoft.Web/sites/config/write.
Base Command#
azure-webapp-auth-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| subscription_id | Subscription ID. | Optional |
| name | Name of the Web App. | Required |
| enabled | True if the Authentication / Authorization feature is enabled for the current app; otherwise, false. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.WebAppAuth.id | String | Resource ID. |
| Azure.WebAppAuth.name | String | Resource Name. |
| Azure.WebAppAuth.type | String | Resource type. |
| Azure.WebAppAuth.properties.enabled | Boolean | Indicates whether Authentication/Authorization is enabled for the app. |
| Azure.WebAppAuth.properties.runtimeVersion | String | The RuntimeVersion of the Authentication/Authorization feature. |
| Azure.WebAppAuth.properties.unauthenticatedClientAction | String | The action to take when an unauthenticated client attempts to access the app. |
| Azure.WebAppAuth.properties.tokenStoreEnabled | Boolean | Indicates whether the Azure App Service Authentication platform’s token store is enabled. |
| Azure.WebAppAuth.properties.allowedExternalRedirectUrls | Unknown | External URLs that are allowed to be redirected to as part of logging in or logging out of the app. |
| Azure.WebAppAuth.properties.defaultProvider | String | The default authentication provider to use when multiple providers are configured. |
| Azure.WebAppAuth.properties.clientId | String | The Client ID of the app used for AAD login. |
| Azure.WebAppAuth.properties.clientSecret | String | The client secret associated with the AAD app. |
| Azure.WebAppAuth.properties.clientSecretSettingName | String | The app setting that contains the client secret. |
| Azure.WebAppAuth.properties.issuer | String | The OpenID Connect Issuer URI that represents the entity that issues access tokens. |
| Azure.WebAppAuth.properties.allowedAudiences | Unknown | The list of audiences that can receive the authentication tokens. |
| Azure.WebAppAuth.properties.additionalLoginParams | Unknown | Additional parameters to send to the authentication provider. |
| Azure.WebAppAuth.properties.isAadAutoProvisioned | Boolean | True if AAD is auto-provisioned; otherwise false. |
| Azure.WebAppAuth.properties.googleClientId | String | The Client ID of the app used for Google login. |
| Azure.WebAppAuth.properties.googleClientSecret | String | The client secret associated with the Google app. |
| Azure.WebAppAuth.properties.googleClientSecretSettingName | String | The app setting that contains the client secret. |
| Azure.WebAppAuth.properties.facebookAppId | String | The App ID of the Facebook app used for login. |
| Azure.WebAppAuth.properties.facebookAppSecret | String | The app secret associated with the Facebook app. |
| Azure.WebAppAuth.properties.facebookAppSecretSettingName | String | The app setting that contains the Facebook app secret. |
| Azure.WebAppAuth.properties.twitterConsumerKey | String | The OAuth 1.0a consumer key of the Twitter application used for login. |
| Azure.WebAppAuth.properties.twitterConsumerSecret | String | The consumer secret associated with the Twitter application. |
| Azure.WebAppAuth.properties.twitterConsumerSecretSettingName | String | The app setting that contains the Twitter consumer secret. |
| Azure.WebAppAuth.properties.microsoftAccountClientId | String | The OAuth 2.0 client ID for the Microsoft account provider. |
| Azure.WebAppAuth.properties.microsoftAccountClientSecret | String | The client secret for the Microsoft account provider. |
| Azure.WebAppAuth.properties.microsoftAccountClientSecretSettingName | String | The app setting that contains the Microsoft account client secret. |
| Azure.WebAppAuth.properties.appleClientId | String | The client ID for the Apple provider. |
| Azure.WebAppAuth.properties.appleClientSecret | String | The client secret for the Apple provider. |
| Azure.WebAppAuth.properties.appleClientSecretSettingName | String | The app setting that contains the Apple provider client secret. |
| Azure.WebAppAuth.properties.authFilePath | String | The path to the authentication configuration file. |
azure-mysql-flexible-server-param-set#
Updates a server configuration. Required permissions: Microsoft.DBforMySQL/flexibleServers/configurations/read, Microsoft.DBforMySQL/flexibleServers/configurations/write.
Base Command#
azure-mysql-flexible-server-param-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| server_name | Name of the MySQL flexible server. | Required |
| configuration_name | The name of the server configuration. | Required |
| source | Source of the configuration. | Optional |
| value | Value of the configuration. | Optional |
Context Output#
There is no context output for this command.
azure-monitor-log-profile-update#
Updates a log profile in Azure Monitoring REST API. Required permissions: Microsoft.Insights/logprofiles/read, Microsoft.Insights/logprofiles/write.
Base Command#
azure-monitor-log-profile-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| log_profile_name | The name of the log profile to update. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| location | Resource location. | Optional |
| retention_policy_days | Number of days to retain logs. | Optional |
| retention_policy_enabled | Whether to enable the retention policy. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Monitor.LogProfiles.id | String | The fully qualified Azure resource ID for the log profile. |
| Azure.Monitor.LogProfiles.name | String | The name of the log profile. |
| Azure.Monitor.LogProfiles.type | String | The type of the resource (Microsoft.Insights/logProfiles). |
| Azure.Monitor.LogProfiles.location | String | The location of the log profile. |
| Azure.Monitor.LogProfiles.tags | Object | Resource tags. |
| Azure.Monitor.LogProfiles.properties.storageAccountId | String | The resource ID of the storage account to which diagnostic logs are delivered. |
| Azure.Monitor.LogProfiles.properties.serviceBusRuleId | String | The service bus rule ID to which diagnostic logs are sent. |
| Azure.Monitor.LogProfiles.properties.locations | Array | A list of regions for which events are collected. |
| Azure.Monitor.LogProfiles.properties.categories | Array | A list of categories of logs that are collected. |
| Azure.Monitor.LogProfiles.properties.retentionPolicy.enabled | Boolean | Specifies whether the retention policy is enabled. |
| Azure.Monitor.LogProfiles.properties.retentionPolicy.days | Number | The number of days for the retention policy. |
azure-disk-update#
Updates a disk. The command is deprecated, please use azure-compute-disk-update. Required Permissions: Microsoft.Compute/disks/read, Microsoft.Compute/disks/write.
Base Command#
azure-disk-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| subscription_id | Subscription ID. | Optional |
| disk_name | The name of the managed disk that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. | Required |
| public_network_access | Policy for controlling export on the disk. Possible values are: Disabled, Enabled. | Optional |
| network_access_policy | Policy for accessing the disk via network. Possible values are: AllowAll, AllowPrivate, DenyAll. | Optional |
| data_access_auth_mode | Additional authentication requirements when exporting or uploading to a disk or snapshot. Possible values are: AzureActiveDirectory. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Disk.id | String | Resource ID of the disk. |
| Azure.Disk.name | String | Name of the disk. |
| Azure.Disk.type | String | Type of the resource. |
| Azure.Disk.location | String | Location of the disk. |
| Azure.Disk.tags | unknown | Resource tags. |
| Azure.Disk.managedBy | String | ARM ID of the resource that manages the disk. |
| Azure.Disk.sku | unknown | The disk SKU name. |
| Azure.Disk.zones | unknown | A list of availability zones. |
| Azure.Disk.properties.timeCreated | String | The time when the disk was created. |
| Azure.Disk.properties.diskSizeGB | Number | Size of the disk in GB. |
| Azure.Disk.properties.diskIopsReadWrite | Number | The number of IOPS allowed for this disk. |
| Azure.Disk.properties.diskMBpsReadWrite | Number | The bandwidth allowed for this disk in MBps. |
| Azure.Disk.properties.diskIOPSReadOnly | Number | The number of read-only IOPS for this disk. |
| Azure.Disk.properties.diskMBpsReadOnly | Number | The read-only bandwidth for this disk in MBps. |
| Azure.Disk.properties.diskSizeBytes | Number | The size of the disk in bytes. |
| Azure.Disk.properties.networkAccessPolicy | String | Policy for accessing the disk via network. |
| Azure.Disk.properties.publicNetworkAccess | String | Policy for export on the disk. |
| Azure.Disk.properties.burstingEnabled | Boolean | Whether bursting is enabled on the disk. |
| Azure.Disk.properties.optimization | String | The disk optimization setting. |
| Azure.Disk.properties.diskState | String | The current state of the disk. |
| Azure.Disk.properties.supportedCapabilities | unknown | Supported capabilities of the disk. |
| Azure.Disk.properties.supportedPerformanceTiers | unknown | Supported performance tiers of the disk. |
| Azure.Disk.properties.supportedDiskTypes | unknown | Supported disk types for the disk. |
| Azure.Disk.properties.provisioningState | unknown | The provisioning state of the disk. |
| Azure.Disk.properties.timeModified | unknown | The time when the disk was last modified. |
| Azure.Disk.properties.diskAccessId | String | The ARM ID of the DiskAccess resource. |
| Azure.Disk.properties.networkProfile | unknown | The network profile of the disk. |
| Azure.Disk.properties.creationData | unknown | Disk creation data. |
| Azure.Disk.properties.encryption | unknown | Encryption settings for the disk. |
| Azure.Disk.properties.encryptionSettingsCollection | unknown | A collection of encryption settings. |
| Azure.Disk.properties.encryptionType | String | The type of key used to encrypt the data on the disk. |
| Azure.Disk.properties.securityProfile | unknown | Security profile for the disk. |
| Azure.Disk.properties.tieringProfile | unknown | Tiering profile for the disk. |
| Azure.Disk.properties.supportedTierList | unknown | List of supported tiers for the disk. |
| Azure.Disk.properties.availabilityZone | String | Availability zone of the disk. |
| Azure.Disk.properties.dataAccessAuthMode | String | Additional authentication requirements when exporting or uploading to a disk. |
| Azure.Disk.properties.osType | String | The operating system type. |
| Azure.Disk.properties.hyperVGeneration | String | The HyperVGenerationType of the virtual machine. |
| Azure.Disk.properties.lastOwnershipUpdateTime | String | The last time ownership of the disk was updated. |
azure-webapp-update#
Updates an Azure Web App. The command is deprecated, please use azure-appservice-webapp-update. Required Permissions: Microsoft.Web/sites/read, Microsoft.Web/sites/write.
Base Command#
azure-webapp-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| subscription_id | Subscription ID. | Optional |
| name | Name of the Web App. | Required |
| identity_type | Managed service identity type. Possible values are: None, SystemAssigned. | Optional |
| https_only | Configures the web site to accept only https requests. Possible values are: true, false. | Optional |
| client_cert_enabled | Configures the web site to accept only https requests. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.WebApp.id | String | Fully qualified resource ID for the web app. |
| Azure.WebApp.name | String | The name of the web app. |
| Azure.WebApp.type | String | The resource type, e.g., Microsoft.Web/sites. |
| Azure.WebApp.location | String | Geographic location of the web app. |
| Azure.WebApp.kind | String | The kind of the app, e.g., app, functionapp, etc. |
| Azure.WebApp.tags | unknown | Resource tags as key-value pairs. |
| Azure.WebApp.identity.type | String | The type of managed identity (SystemAssigned, UserAssigned, etc.). |
| Azure.WebApp.identity.principalId | String | The principal ID of the system-assigned identity. |
| Azure.WebApp.identity.tenantId | String | The tenant ID of the system-assigned identity. |
| Azure.WebApp.identity.userAssignedIdentities | unknown | The list of user-assigned identities associated with the web app. |
| Azure.WebApp.properties.state | String | Current state of the web app (Running, Stopped, etc.). |
| Azure.WebApp.properties.enabled | Boolean | Whether the web app is enabled. |
| Azure.WebApp.properties.defaultHostName | String | Default host name of the web app. |
| Azure.WebApp.properties.hostNames | unknown | List of host names associated with the web app. |
| Azure.WebApp.properties.repositorySiteName | String | Name of the repository site. |
| Azure.WebApp.properties.clientAffinityEnabled | Boolean | Whether client affinity is enabled. |
| Azure.WebApp.properties.clientCertEnabled | Boolean | Whether client certificates are enabled. |
| Azure.WebApp.properties.clientCertExclusionPaths | String | Paths to exclude from client certificate authentication. |
| Azure.WebApp.properties.hostingEnvironment | String | App Service Environment to use for the web app. |
| Azure.WebApp.properties.serverFarmId | String | Resource ID of the associated App Service plan. |
| Azure.WebApp.properties.reserved | Boolean | Whether the web app is on a Linux plan. |
| Azure.WebApp.properties.isXenon | Boolean | Whether the web app is hosted in Xenon. |
| Azure.WebApp.properties.hyperV | Boolean | Whether Hyper-V is enabled for the web app. |
| Azure.WebApp.properties.siteConfig.appSettings | unknown | List of app settings. |
| Azure.WebApp.properties.siteConfig.metadata | unknown | List of metadata settings. |
| Azure.WebApp.properties.siteConfig.connectionStrings | unknown | List of connection strings. |
| Azure.WebApp.properties.siteConfig.localMySqlEnabled | Boolean | Whether local MySQL is enabled. |
| Azure.WebApp.properties.siteConfig.alwaysOn | Boolean | Whether Always On is enabled. |
| Azure.WebApp.properties.siteConfig.http20Enabled | Boolean | Whether HTTP/2 is enabled. |
| Azure.WebApp.properties.siteConfig.minTlsVersion | String | Minimum TLS version required. |
| Azure.WebApp.properties.siteConfig.ftpsState | String | FTPS state (Disabled, AllAllowed, etc.). |
| Azure.WebApp.properties.siteConfig.linuxFxVersion | String | Runtime stack for Linux apps. |
| Azure.WebApp.properties.siteConfig.windowsFxVersion | String | Runtime stack for Windows apps. |
| Azure.WebApp.properties.siteConfig.numberOfWorkers | Number | Number of workers allocated. |
| Azure.WebApp.properties.siteConfig.webSocketsEnabled | Boolean | Whether WebSockets are enabled. |
| Azure.WebApp.properties.siteConfig.preWarmedInstanceCount | Number | Number of pre-warmed instances. |
| Azure.WebApp.properties.siteConfig.acrUseManagedIdentityCreds | Boolean | Whether ACR uses managed identity credentials. |
| Azure.WebApp.properties.siteConfig.acrUserManagedIdentityID | String | User-assigned identity ID for ACR. |
| Azure.WebApp.properties.siteConfig.scmType | String | Source control management type. |
| Azure.WebApp.properties.siteConfig.use32BitWorkerProcess | Boolean | Whether to use 32-bit worker process. |
| Azure.WebApp.properties.siteConfig.autoHealEnabled | Boolean | Whether auto-heal is enabled. |
| Azure.WebApp.properties.siteConfig.autoHealRules | unknown | Auto-heal rules configuration. |
| Azure.WebApp.properties.siteConfig.tracingOptions | String | Tracing options. |
| Azure.WebApp.properties.siteConfig.remoteDebuggingEnabled | Boolean | Whether remote debugging is enabled. |
| Azure.WebApp.properties.siteConfig.remoteDebuggingVersion | String | Remote debugging version. |
| Azure.WebApp.properties.siteConfig.detailedErrorLoggingEnabled | Boolean | Whether detailed error logging is enabled. |
| Azure.WebApp.properties.siteConfig.httpLoggingEnabled | Boolean | Whether HTTP logging is enabled. |
| Azure.WebApp.properties.siteConfig.requestTracingEnabled | Boolean | Whether request tracing is enabled. |
| Azure.WebApp.properties.siteConfig.requestTracingExpirationTime | DateTime | Request tracing expiration time. |
| Azure.WebApp.properties.siteConfig.remoteDebuggingEnabled | Boolean | Whether remote debugging is enabled. |
| Azure.WebApp.properties.siteConfig.remoteDebuggingVersion | String | Remote debugging version. |
| Azure.WebApp.properties.siteConfig.defaultDocuments | unknown | List of default documents. |
| Azure.WebApp.properties.siteConfig.virtualApplications | unknown | List of virtual applications. |
| Azure.WebApp.properties.siteConfig.loadBalancing | String | Load balancing settings. |
| Azure.WebApp.properties.siteConfig.experiments | unknown | Experiments configuration. |
| Azure.WebApp.properties.siteConfig.limits | unknown | Site limits configuration. |
| Azure.WebApp.properties.siteConfig.autoSwapSlotName | String | Auto-swap slot name. |
| Azure.WebApp.properties.siteConfig.localMySqlEnabled | Boolean | Whether local MySQL is enabled. |
| Azure.WebApp.properties.siteConfig.ipSecurityRestrictions | unknown | IP security restrictions. |
| Azure.WebApp.properties.siteConfig.scmIpSecurityRestrictions | unknown | SCM IP security restrictions. |
| Azure.WebApp.properties.siteConfig.scmIpSecurityRestrictionsUseMain | Boolean | Whether SCM IP restrictions use main settings. |
| Azure.WebApp.properties.siteConfig.cors | unknown | CORS settings. |
| Azure.WebApp.properties.siteConfig.push | unknown | Push settings. |
| Azure.WebApp.properties.siteConfig.apiDefinition | unknown | API definition settings. |
| Azure.WebApp.properties.siteConfig.apiManagementConfig | unknown | API management configuration. |
| Azure.WebApp.properties.siteConfig.autoHealEnabled | Boolean | Whether auto-heal is enabled. |
| Azure.WebApp.properties.siteConfig.autoHealRules | unknown | Auto-heal rules configuration. |
| Azure.WebApp.properties.siteConfig.tracingOptions | String | Tracing options. |
| Azure.WebApp.properties.siteConfig.remoteDebuggingEnabled | Boolean | Whether remote debugging is enabled. |
| Azure.WebApp.properties.siteConfig.remoteDebuggingVersion | String | Remote debugging version. |
| Azure.WebApp.properties.siteConfig.detailedErrorLoggingEnabled | Boolean | Whether detailed error logging is enabled. |
| Azure.WebApp.properties.siteConfig.httpLoggingEnabled | Boolean | Whether HTTP logging is enabled. |
| Azure.WebApp.properties.siteConfig.requestTracingEnabled | Boolean | Whether request tracing is enabled. |
azure-acr-update#
Updates a container registry. The command is deprecated, please use azure-cr-registry-update. Required Permissions: Microsoft.ContainerRegistry/registries/read, Microsoft.ContainerRegistry/registries/write.
Base Command#
azure-acr-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| subscription_id | Subscription ID. | Optional |
| registry_name | The name of the container registry. | Required |
| allow_exports | Whether artifacts can be exported. Possible values are: disabled, enabled. | Optional |
| public_network_access | Whether public network access is allowed for the container registry. Possible values are: disabled, enabled. | Optional |
| anonymous_pull_enabled | Whether to enable registry-wide pulls from unauthenticated clients. Possible values are: true, false. | Optional |
| authentication_as_arm_policy | Whether the policy is enabled or not. Possible values are: disabled, enabled. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ACR.id | String | The resource ID. |
| Azure.ACR.identity | Unknown | The identity of the container registry. |
| Azure.ACR.location | String | The location of the resource. |
| Azure.ACR.name | String | The name of the resource. |
| Azure.ACR.properties.adminUserEnabled | Boolean | The value that indicates whether the admin user is enabled. |
| Azure.ACR.properties.anonymousPullEnabled | Boolean | Enables registry-wide pull from unauthenticated clients. |
| Azure.ACR.properties.creationDate | String | The creation date of the container registry in ISO8601 format. |
| Azure.ACR.properties.dataEndpointEnabled | Boolean | Enable a single data endpoint per region for serving data. |
| Azure.ACR.properties.dataEndpointHostNames | Unknown | List of host names that will serve data when dataEndpointEnabled is true. |
| Azure.ACR.properties.encryption | Unknown | The encryption settings of container registry. |
| Azure.ACR.properties.loginServer | String | The URL that can be used to log into the container registry. |
| Azure.ACR.properties.networkRuleBypassOptions | String | Whether to allow trusted Azure services to access a network restricted registry. |
| Azure.ACR.properties.networkRuleSet | Unknown | The network rule set for a container registry. |
| Azure.ACR.properties.policies | Unknown | The policies for a container registry. |
| Azure.ACR.properties.privateEndpointConnections | Unknown | List of private endpoint connections for a container registry. |
| Azure.ACR.properties.provisioningState | String | The provisioning state of the container registry at the time the operation was called. |
| Azure.ACR.properties.publicNetworkAccess | String | Whether or not public network access is allowed for the container registry. |
| Azure.ACR.properties.status | Unknown | The status of the container registry at the time the operation was called. |
| Azure.ACR.properties.zoneRedundancy | String | Whether or not zone redundancy is enabled for this container registry. |
| Azure.ACR.sku | Unknown | The SKU of the container registry. |
| Azure.ACR.systemData | Unknown | Metadata pertaining to creation and last modification of the resource. |
| Azure.ACR.tags | Unknown | The tags of the resource. |
| Azure.ACR.type | String | The type of the resource. |
azure-postgres-server-update#
Updates an existing server. The command is deprecated due to the retirement of Azure PostgreSQL Single Server.
Base Command#
azure-postgres-server-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Optional |
| subscription_id | Subscription ID. | Optional |
| server_name | Name of the PostgreSQL server. | Required |
| ssl_enforcement | Whether to enable SSL authentication when connecting to the server. Possible values are: Disabled, Enabled. | Optional |
Context Output#
There is no context output for this command.
azure-key-vault-update#
Updates a key vault in the specified subscription. The command is deprecated, please use azure-keyvault-vault-update. Required Permissions: Microsoft.KeyVault/vaults/read, Microsoft.KeyVault/vaults/write.
Base Command#
azure-key-vault-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| vault_name | Key Vault name. | Required |
| subscription_id | The subscription ID. | Optional |
| resource_group_name | The name of the resource group. | Optional |
| enable_purge_protection | Whether protection against purge is enabled for this vault. This functionality is always enabled, it cannot be disabled. Possible values are: true. | Optional |
| enable_soft_delete | Whether soft delete is enabled for this key vault. This functionality is always enabled, it cannot be disabled. Possible values are: true. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.KeyVault.id | String | Resource ID. |
| Azure.KeyVault.name | String | Key Vault name. |
| Azure.KeyVault.type | String | Resource type in Azure. |
| Azure.KeyVault.location | String | Key Vault location. |
| Azure.KeyVault.tags | unknown | Resource tags. |
| Azure.KeyVault.properties.sku.family | String | SKU family name. |
| Azure.KeyVault.properties.sku.name | String | SKU name to specify whether the key vault is a standard vault or a premium vault. |
| Azure.KeyVault.properties.tenantId | String | The Entra ID tenant ID that should be used for authenticating requests to the key vault. |
| Azure.KeyVault.properties.accessPolicies | unknown | An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. |
| Azure.KeyVault.properties.accessPolicies.tenantId | String | The Entra ID tenant ID that should be used for authenticating requests to the key vault. |
| Azure.KeyVault.properties.accessPolicies.objectId | String | The object ID of a user, service principal or security group in the Entra ID tenant for the vault. The object ID must be unique for the list of access policies. |
| Azure.KeyVault.properties.accessPolicies.permissions | unknown | Permissions the identity has for keys, secrets and certificates. |
| Azure.KeyVault.properties.enabledForDeployment | Boolean | Whether Azure Virtual Machines are allowed to retrieve certificates stored as secrets from the key vault. |
| Azure.KeyVault.properties.enabledForDiskEncryption | Boolean | Whether Azure Disk Encryption is allowed to retrieve secrets from the vault and unwrap keys. |
| Azure.KeyVault.properties.enabledForTemplateDeployment | Boolean | Whether Azure Resource Manager is allowed to retrieve secrets from the key vault. |
| Azure.KeyVault.properties.enableSoftDelete | Boolean | Whether soft delete is enabled for this key vault. |
| Azure.KeyVault.properties.enablePurgeProtection | Boolean | Whether purge protection is enabled for this key vault. |
| Azure.KeyVault.properties.enableRbacAuthorization | Boolean | Whether Azure Key Vault uses Role Based Access Control (RBAC) for authorization of data actions. |
| Azure.KeyVault.properties.vaultUri | String | The URI of the vault for performing operations on keys and secrets. |
| Azure.KeyVault.properties.provisioningState | String | The current provisioning state. |
| Azure.KeyVault.properties.privateEndpointConnections | unknown | List of private endpoint connections associated with the key vault. |
| Azure.KeyVault.properties.networkAcls | unknown | Rules governing the accessibility of the key vault from specific network locations. |
| Azure.KeyVault.properties.networkAcls.bypass | String | What traffic can bypass network rules. |
| Azure.KeyVault.properties.networkAcls.defaultAction | String | The default action when no rules match from ipRules and virtualNetworkRules. |
| Azure.KeyVault.properties.networkAcls.ipRules | unknown | The list of IP address rules. |
| Azure.KeyVault.properties.networkAcls.virtualNetworkRules | unknown | The list of virtual network rules. |
azure-sql-db-threat-policy-update#
Updates the database's threat detection policy. The command is deprecated, please use azure-sqldb-security-alert-policy-update. Required Permissions: Microsoft.Sql/servers/databases/securityAlertPolicies/read, Microsoft.Sql/servers/databases/securityAlertPolicies/write.
Base Command#
azure-sql-db-threat-policy-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| server_name | Server name. | Required |
| db_name | Database name. | Required |
| email_account_admins_enabled | Whether the alert is sent to the account administrators. Possible values: "true" and "false". Possible values are: true, false. | Optional |
| subscription_id | Subscription ID. | Optional |
| resource_group_name | The name of the resource group. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.SqlDBThreatPolicy.kind | String | Kind of threat policy. |
| Azure.SqlDBThreatPolicy.location | String | Threat policy location. |
| Azure.SqlDBThreatPolicy.id | String | Threat policy ID. |
| Azure.SqlDBThreatPolicy.name | String | Threat policy name. |
| Azure.SqlDBThreatPolicy.type | String | Threat policy type. |
| Azure.SqlDBThreatPolicy.state | String | Threat policy state. |
| Azure.SqlDBThreatPolicy.creationTime | String | Threat policy creation time. |
| Azure.SqlDBThreatPolicy.retentionDays | Number | Number of days to keep in the Threat Detection audit logs. |
| Azure.SqlDBThreatPolicy.storageAccountAccessKey | String | The identifier key of the Threat Detection audit storage account. |
| Azure.SqlDBThreatPolicy.storageEndpoint | String | Threat Detection audit storage account. |
| Azure.SqlDBThreatPolicy.emailAccountAdmins | Boolean | Email accounts administrators who the alert is sent to. |
| Azure.SqlDBThreatPolicy.emailAddresses | String | List of email addresses to which the alert is sent. |
| Azure.SqlDBThreatPolicy.disabledAlerts | String | List of alerts that are disabled, or an empty string if no alerts are disabled. |
| Azure.SqlDBThreatPolicy.useServerDefault | unknown | Whether to use the default server policy. |
| Azure.SqlDBThreatPolicy.databaseName | String | The name of the database that the threat policy is related to. |
| Azure.SqlDBThreatPolicy.serverName | String | The name of server that the threat policy is related to. |
azure-sql-db-transparent-data-encryption-set#
Updates a logical database's transparent data encryption configuration. Required permissions: Microsoft.Sql/servers/databases/transparentDataEncryption/read, Microsoft.Sql/servers/databases/transparentDataEncryption/write.
Base Command#
azure-sql-db-transparent-data-encryption-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| server_name | Server name. | Required |
| db_name | Database name. | Required |
| state | The state of the transparent data encryption. Possible values are: Disabled, Enabled. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
Context Output#
There is no context output for this command.
azure-vm-instance-details-get#
Gets the properties of a given virtual machine. The command is deprecated, please use azure-compute-vm-get. Required Permissions: Microsoft.Compute/virtualMachines/read.
Base Command#
azure-vm-instance-details-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group to which the virtual machine belongs. To see all the resource groups associated with your subscription, run the azure-list-resource-groups command. | Required |
| virtual_machine_name | The name of the virtual machine you want to view the details of. | Required |
| expand | The expand expression to apply on the operation. 'instanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'userData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation. Default value is False. Possible values are: instanceView, userData. Default is instanceView. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.name | string | The name of the virtual machine you want to get details of. |
| Azure.Compute.id | string | The ID of the virtual machine. |
| Azure.Compute.location | string | The region in which the virtual machine is hosted. |
| Azure.Compute.Size | number | The size of the deployed virtual machine (in gigabytes). |
| Azure.Compute.OS | string | The OS running on the given virtual machine. |
| Azure.Compute.properties.provisioningState | string | The provisioning state of the deployed virtual machine. |
| Azure.Compute.networkProfile.networkInterfaces | string | The list of network interfaces attached to this virtual machine. |
| Azure.Compute.properties.hardwareProfile.vmSize | string | The size or SKU of the virtual machine, defining CPU, memory, and storage capacity. |
| Azure.Compute.properties.provisioningState | string | The current provisioning state of the virtual machine (e.g., Succeeded, Updating, Failed). |
| Azure.Compute.properties.osProfile | string | The operating system configuration of the virtual machine, including admin credentials and hostname. |
| Azure.Compute.properties.storageProfile | string | The storage settings for the virtual machine, including OS and data disks. |
| Azure.Compute.properties.vmId | string | The unique identifier assigned to the virtual machine instance. |
| Azure.Compute.properties.instanceView | string | Detailed runtime status information about the virtual machine, such as power state and extensions. |
| Azure.Compute.properties.timeCreated | string | The timestamp when the virtual machine was created. |
| Azure.Compute.properties.networkProfile | string | The network configuration of the virtual machine, including associated network interfaces and settings. |
| Azure.Compute.properties.diagnosticsProfile | string | The configuration for boot diagnostics and monitoring of the virtual machine. |
azure-nsg-security-groups-list#
List all network security groups. The command is deprecated, please use azure-vn-security-groups-list. Required Permissions: Microsoft.Network/networkSecurityGroups/read.
Base Command#
azure-nsg-security-groups-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGSecurityGroup.name | String | The security group's name. |
| Azure.NSGSecurityGroup.id | String | The security group's ID. |
| Azure.NSGSecurityGroup.type | String | The security group's type. |
| Azure.NSGSecurityGroup.location | String | The security group's location. |
| Azure.NSGSecurityGroup.etag | String | The security group's ETag. |
| Azure.NSGSecurityGroup.tags | String | The security group's tags. |
| Azure.NSGSecurityGroup.properties.defaultSecurityRules | List | The default security rules. |
| Azure.NSGSecurityGroup.properties.networkInterfaces | List | The network interfaces. |
| Azure.NSGSecurityGroup.properties.provisioningState | String | The provisioning state. |
| Azure.NSGSecurityGroup.properties.resourceGuid | String | The resource GUID. |
| Azure.NSGSecurityGroup.properties.SecurityRules | List | The security rules. |
azure-nsg-security-rule-delete#
Delete a security rule. The command is deprecated, please use azure-vn-security-rule-delete. Required Permissions: Microsoft.Network/networkSecurityGroups/securityRules/delete.
Base Command#
azure-nsg-security-rule-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | Resource group name. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to delete. | Required |
Context Output#
There is no context output for this command.
azure-storage-blob-containers-update#
Run this command to update a specific blob container. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/write. The command is deprecated, please use azure-storage-blob-container-update.
Base Command#
azure-storage-blob-containers-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| container_name | The container name. | Required |
| default_encryption_scope | Uses the specified encryption scope by default for all writes to the container. | Optional |
| deny_encryption_scope_override | Blocks overriding the container’s default encryption scope. Possible values: true, false. Possible values are: true, false. | Optional |
| public_access | Specifies the access level. Possible values: Blob, Container, None. Possible values are: Blob, Container, None. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.StorageBlobContainer.id | String | Fully qualified resource ID for the resource. |
| Azure.StorageBlobContainer.name | String | The name of the resource. |
| Azure.StorageBlobContainer.type | String | The resource type. |
| Azure.StorageBlobContainer.properties.metadata.metadata | String | A metadata entry for the container, in name–value format. |
| Azure.StorageBlobContainer.properties.publicAccess | String | Specifies whether data in the container may be accessed publicly and the access level. |
| Azure.StorageBlobContainer.properties.hasImmutabilityPolicy | Boolean | The hasImmutabilityPolicy property is set to true by SRP if an ImmutabilityPolicy exists for this container, and false if it does not. |
| Azure.StorageBlobContainer.properties.hasLegalHold | Boolean | The hasLegalHold property is set to true by SRP if at least one legal hold tag exists, and false if all tags are cleared. |
azure-vm-instance-start#
Powers on a given virtual machine. The command is deprecated, please use azure-compute-vm-start. Required Permissions: Microsoft.Compute/virtualMachines/read, Microsoft.Compute/virtualMachines/start/action.
Base Command#
azure-vm-instance-start
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | Resource Group to which the virtual machine belongs. To see all the resource groups associated with your subscription, run the azure-list-resource-groups command. | Required |
| virtual_machine_name | Name of the virtual machine to power on. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.name | string | Name of the VM that was started. |
| Azure.Compute.resourceGroup | string | Resource group the VM resides in. |
| Azure.Compute.powerState | string | Whether the VM instance is powered on or off. |
azure-nsg-network-interfaces-list#
Gets network interfaces in a resource group. The command is deprecated, please use azure-vn-network-interfaces-list. Required Permissions: Microsoft.Network/networkInterfaces/read.
Base Command#
azure-nsg-network-interfaces-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The subscription ID. | Required |
| limit | The maximum number of records to return. Default is 50. | Optional |
| all_results | Whether to retrieve all results by overriding the default limit. Possible values are: false, true. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGNetworkInterfaces.name | String | The network interface's name. |
| Azure.NSGNetworkInterfaces.id | String | The network interface's ID. |
| Azure.NSGNetworkInterfaces.kind | String | The kind of the network interface. |
| Azure.NSGNetworkInterfaces.etag | String | The ETag of the network interface. |
| Azure.NSGNetworkInterfaces.location | String | The location of the network interface. |
| Azure.NSGNetworkInterfaces.managedBy | String | The entity that manages the network interface. |
| Azure.NSGNetworkInterfaces.tags | String | The tags associated with the network interface. |
| Azure.NSGNetworkInterfaces.properties.provisioningState | String | The network interface's provisioning state. |
| Azure.NSGNetworkInterfaces.properties.ipConfigurations.name | List | The name of the IP configuration resource that is unique within a resource group. |
| Azure.NSGNetworkInterfaces.properties.ipConfigurations.id | List | The IP configuration resource ID. |
| Azure.NSGNetworkInterfaces.properties.ipConfigurations.etag | List | The ETag of the IP configuration. |
| Azure.NSGNetworkInterfaces.properties.ipConfigurations.type | List | The type of the IP configuration resource. |
| Azure.NSGNetworkInterfaces.properties.tapConfigurations | List | List of tap configurations. |
| Azure.NSGNetworkInterfaces.properties.allowPort25Out | Boolean | Whether port 25 outbound traffic is allowed. |
| Azure.NSGNetworkInterfaces.properties.nicType | String | The network interface card type (Standard/Basic). |
azure-vm-network-interface-details-get#
Gets the properties of a given network interface. The command is deprecated, please use azure-vn-network-interface-get. Required Permissions: Microsoft.Network/networkInterfaces/read.
Base Command#
azure-vm-network-interface-details-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group to which the network interface belongs. To see all the resource groups associated with your subscription, run the azure-list-resource-groups command. | Required |
| network_interface_name | The name of the network interface you want to view the details of. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Network.Interfaces.properties.ipConfigurations | Unknown | The interface public IP address ID. |
| Azure.Network.Interfaces.properties.macAddress | String | The interface MAC address. |
| Azure.Network.Interfaces.name | String | The interface name. |
| Azure.Network.Interfaces.location | String | The interface location. |
| Azure.Network.Interfaces.id | String | The interface ID. |
| Azure.Network.Interfaces.location | String | The Azure region where the network interface is deployed. |
| Azure.Network.Interfaces.etag | String | A unique read-only string that changes whenever the network interface resource is updated. |
| Azure.Network.Interfaces.kind | String | The type of the network interface resource, used for Azure internal classification. |
| Azure.Network.Interfaces.properties.tapConfigurations | String | The list of tap configurations attached to the network interface for traffic mirroring. |
| Azure.Network.Interfaces.properties.allowPort25Out | String | Indicates whether outbound traffic on port 25 (SMTP) is allowed from this network interface. |
| Azure.Network.Interfaces.properties.nicType | String | Specifies the type of network interface, such as Standard or Elastic. |
| Azure.Network.Interfaces.properties.provisioningState | String | The current provisioning state of the network interface (e.g., Succeeded, Updating, Failed). |
| Azure.Network.Interfaces.properties.dnsSettings | String | The DNS configuration of the network interface, including DNS servers and domain name. |
| Azure.Network.Interfaces.properties.enableIPForwarding | String | Indicates whether IP forwarding is enabled for the network interface. |
azure-nsg-security-rule-get#
Get a specific rule. The command is deprecated, please use azure-vn-security-rule-get. Required Permissions: Microsoft.Network/networkSecurityGroups/securityRules/read.
Base Command#
azure-nsg-security-rule-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | Resource group name. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to get. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGRule.name | String | The rule's name. |
| Azure.NSGRule.id | String | The rule's ID. |
| Azure.NSGRule.location | String | The rule's location. |
| Azure.NSGRule.etag | String | The rule's ETag. |
| Azure.NSGRule.type | String | The rule's type. |
| Azure.NSGRule.properties.provisioningState | String | The rule's provisioning state. |
| Azure.NSGRule.properties.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.NSGRule.properties.sourcePortRange | String | For a single port, the source port or a range of ports. For multiple ports, `sourcePortRanges` is used instead. |
| Azure.NSGRule.properties.sourcePortRanges | String | For multiple ports, a list of ports. For a single port, `sourcePortRange` is used instead. |
| Azure.NSGRule.properties.destinationPortRange | String | For a single port, the destination port or range of ports. For multiple ports, `destinationPortRanges` is used instead. |
| Azure.NSGRule.properties.destinationPortRanges | String | For multiple ports, a list of destination ports. For a single port, `destinationPortRange` is used instead. |
| Azure.NSGRule.properties.sourceAddressPrefix | String | The source address. |
| Azure.NSGRule.properties.destinationAddressPrefix | String | The destination address. |
| Azure.NSGRule.properties.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.NSGRule.properties.priority | Number | The rule’s priority, ranging from 100 to 4096. |
| Azure.NSGRule.properties.direction | String | The rule's direction, which can be "Inbound" or "Outbound". |
azure-nsg-public-ip-addresses-list#
Gets public IP addresses in a resource group. The command is deprecated, please use azure-vn-public-ip-addresses-list. Required Permissions: Microsoft.Network/publicIPAddresses/read.
Base Command#
azure-nsg-public-ip-addresses-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The subscription ID. | Required |
| limit | The maximum number of records to return. Default is 50. | Optional |
| all_results | Whether to retrieve all results by overriding the default limit. Possible values are: false, true. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGPublicIPAddress.name | String | The public IP address's name. |
| Azure.NSGPublicIPAddress.id | String | The public IP address's ID. |
| Azure.NSGPublicIPAddress.location | String | The location of the public IP address. |
| Azure.NSGPublicIPAddress.sku | String | The public IP address's SKU. |
| Azure.NSGPublicIPAddress.type | String | The type of the public IP address. |
| Azure.NSGPublicIPAddress.etag | String | The public IP address's ETag. |
| Azure.NSGPublicIPAddress.properties.provisioningState | String | The public IP address's provisioning state. |
| Azure.NSGPublicIPAddress.properties.publicIPAddressVersion | String | The public IP address's version. |
| Azure.NSGPublicIPAddress.properties.ipAddress | String | The public IP address's IP address. |
| Azure.NSGPublicIPAddress.properties.domainNameLabel | String | The public IP address's domain name label. |
| Azure.NSGPublicIPAddress.properties.publicIPAllocationMethod | String | The public IP address's allocation method. |
| Azure.NSGPublicIPAddress.properties.fqdn | String | The public IP address's fully qualified domain name (FQDN). |
| Azure.NSGPublicIPAddress.properties.resourceGuid | String | The public IP address's resource GUID. |
| Azure.NSGPublicIPAddress.sku.name | String | The public IP address's SKU name. |
| Azure.NSGPublicIPAddress.sku.tier | String | The public IP address's SKU tier. |
azure-storage-blob-service-properties-get#
Run this command to get the blob service properties of a specific account storage. The command is deprecated, please use azure-storage-blob-service-property-get. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/read, Microsoft.Storage/storageAccounts/blobServices/write.
Base Command#
azure-storage-blob-service-properties-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.StorageBlobServiceProperties.id | String | Fully qualified resource ID for the resource. |
| Azure.StorageBlobServiceProperties.name | String | The name of the resource. |
| Azure.StorageBlobServiceProperties.type | String | The resource type. |
| Azure.StorageBlobServiceProperties.properties.lastAccessTimeTrackingPolicy.enable | Boolean | When set to true, last access time–based tracking is enabled. |
| Azure.StorageBlobServiceProperties.properties.lastAccessTimeTrackingPolicy.name | String | Name of the policy. The valid value is AccessTimeTracking. |
| Azure.StorageBlobServiceProperties.properties.lastAccessTimeTrackingPolicy.trackingGranularityInDays | Number | Specifies the blob object tracking granularity in days, indicating how often the blob should be tracked. |
| Azure.StorageBlobServiceProperties.properties.lastAccessTimeTrackingPolicy.blobType | String | An array of predefined, supported blob types. The only supported value is BlockBlob. |
azure-vm-public-ip-details-get#
Gets the properties of a given public IP address. The command is deprecated, please use azure-vn-public-ip-address-get. Required Permissions: Microsoft.Network/publicIPAddresses/read.
Base Command#
azure-vm-public-ip-details-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group to which the IP address belongs. To see all the resource groups associated with your subscription, run the azure-list-resource-groups command. | Required |
| address_name | The IP address name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Network.IPConfigurations.location | String | The Azure region where the IP configuration resource is located. |
| Azure.Network.IPConfigurations.id | String | The unique resource ID of the IP configuration. |
| Azure.Network.IPConfigurations.name | String | The name of the IP configuration. |
| Azure.Network.IPConfigurations.etag | String | A unique read-only string that changes whenever the IP configuration resource is updated. |
| Azure.Network.IPConfigurations.properties.idleTimeoutInMinutes | String | The idle timeout value in minutes for the associated public IP address. |
| Azure.Network.IPConfigurations.properties.ipAddress | String | The private IP address assigned to the network interface or resource. |
| Azure.Network.IPConfigurations.properties.provisioningState | String | The current provisioning state of the IP configuration (e.g., Succeeded, Updating, Failed). |
| Azure.Network.IPConfigurations.properties.ipConfiguration | String | The reference to another IP configuration associated with this resource. |
| Azure.Network.IPConfigurations.properties.publicIPAddressVersion | String | The version of the public IP address (IPv4 or IPv6). |
| Azure.Network.IPConfigurations.properties.publicIPAllocationMethod | String | Defines how the public IP address is allocated — Static or Dynamic. |
| Azure.Network.IPConfigurations.properties.resourceGuid | String | The unique Azure resource GUID for the IP configuration. |
| Azure.Network.IPConfigurations.properties.sku | String | The SKU of the public IP address associated with the configuration, defining its performance tier. |
azure-nsg-security-rule-create#
Create a security rule. The command is deprecated, please use azure-vn-security-rule-create. Required Permissions: Microsoft.Network/networkSecurityGroups/securityRules/read, Microsoft.Network/networkSecurityGroups/securityRules/write.
Base Command#
azure-nsg-security-rule-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | Resource group name. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to create. | Required |
| direction | The direction of the rule. Possible values are: "Inbound" and "Outbound". Possible values are: Inbound, Outbound. | Required |
| action | Whether to allow the traffic. Possible values are: "Allow" and "Deny". Possible values are: Allow, Deny. Default is Allow. | Optional |
| protocol | The protocol on which to apply the rule. Possible values are: "Any", "TCP", "UDP" and "ICMP". Possible values are: Any, TCP, UDP, ICMP. Default is Any. | Optional |
| source | The source IP address range from which incoming traffic is allowed or denied by this rule. Possible values are "Any", an IP address range, an application security group, or a default tag. Default is "Any". Default is Any. | Optional |
| priority | The priority of the rule, with a value between 100 and 4096. Each rule in the collection must have a unique priority number. Lower numbers indicate higher priority. | Required |
| source_ports | The source ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk () to allow traffic on any port. Default is "". Default is *. | Optional |
| destination | The destination IP address range for outgoing traffic that is allowed or denied by this rule. The destination filter can be "Any", an IP address range, an application security group, or a default tag. Default is Any. | Optional |
| destination_ports | The destination ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk () to allow traffic on any port. Default is. | Optional |
| description | A description to add to the rule. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGRule.name | String | The rule's name. |
| Azure.NSGRule.id | String | The rule's ID. |
| Azure.NSGRule.etag | String | The rule's ETag. |
| Azure.NSGRule.type | String | The rule's type. |
| Azure.NSGRule.properties.provisioningState | String | The rule's provisioning state. |
| Azure.NSGRule.properties.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.NSGRule.properties.sourcePortRange | String | For a single port, the source port or a range of ports. For multiple ports, `sourcePortRanges` is used instead. |
| Azure.NSGRule.properties.sourcePortRanges | String | For multiple ports, a list of ports. For a single port, `sourcePortRange` is used instead. |
| Azure.NSGRule.properties.destinationPortRange | String | For a single port, the destination port or range of ports. For multiple ports, `destinationPortRanges` is used instead. |
| Azure.NSGRule.properties.destinationPortRanges | String | For multiple ports, a list of destination ports. For a single port, `destinationPortRange` is used instead. |
| Azure.NSGRule.properties.sourceAddressPrefix | String | The source address. |
| Azure.NSGRule.properties.destinationAddressPrefix | String | The destination address. |
| Azure.NSGRule.properties.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.NSGRule.properties.priority | Number | The rule’s priority, ranging from 100 to 4096. |
| Azure.NSGRule.properties.direction | String | The rule's direction, which can be "Inbound" or "Outbound". |
azure-nsg-resource-group-list#
Gets all resource groups for a subscription. The command is deprecated, please use azure-rm-resource-groups-list. Required Permissions: Microsoft.Resources/subscriptions/resourceGroups/read.
Base Command#
azure-nsg-resource-group-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| limit | Limit on the number of resource groups to return. Default is 50. | Optional |
| tag | A single tag in the form of {"Tag Name":"Tag Value"} to filter the list by. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.NSGResourceGroup.id | String | The unique identifier of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.name | String | The name of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.type | String | The type of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.location | String | The location of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.properties.provisioningState | String | The provisioning state of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.tags.Owner | String | The owner tag of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.tags | Unknown | The tags associated with the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.tags.Name | String | The name tag of the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.managedBy | String | The entity that manages the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.tags.aNSG-managed-cluster-name | String | The ANSG managed cluster name tag associated with the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.tags.aNSG-managed-cluster-rg | String | The ANSG managed cluster resource group tag associated with the Azure Network Security Groups resource group. |
| Azure.NSGResourceGroup.tags.type | String | The type tag associated with the Azure Network Security Groups resource group. |
azure-vm-instance-power-off#
Powers off a given virtual machine. The command is deprecated, please use azure-compute-vm-power-off. Required Permissions: Microsoft.Compute/virtualMachines/read, Microsoft.Compute/virtualMachines/poweroff/action.
Base Command#
azure-vm-instance-power-off
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group to which the virtual machine belongs. | Required |
| virtual_machine_name | The name of the virtual machine to power off. To see all virtual machines with their associated names for a specific resource group, run the azure-compute-vm-list command. | Required |
| skip_shutdown | Set to True to request non-graceful VM shutdown. Possible values are: true, false. Default is false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.name | string | The name of the virtual machine that was powered off. |
| Azure.Compute.resourceGroup | string | The resource group in which the virtual machine resides. |
| Azure.Compute.powerState | string | Whether the virtual machine instance is powered on or off. |
azure-billing-usage-list#
Returns actual usage and cost details for a given time period, optionally filtered by service name. Required permission: Microsoft.Consumption/usageDetails/read.
Base Command#
azure-billing-usage-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| expand_result | Whether to expand the result. Default - false. Possible values are: false, true. | Optional |
| filter | Optional filter for the API. API argument - $filter. | Optional |
| metric | The metric to retrieve. API values [actualcost, amortizedcost, usage]. Possible values are: Actual Cost, Amortized Cost, Usage. | Optional |
| max_results | Maximum results to return. Default - 50, Max - 1000. Default is 50. | Optional |
| next_page_token | Next page token for pagination. Use value from Azure.Billing.UsageNextToken. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Billing.Usage | unknown | List of usage details from Azure Consumption API. |
| Azure.Billing.Usage.id | String | Fully qualified resource ID for the usage detail. |
| Azure.Billing.Usage.name | String | Name of the usage detail resource. |
| Azure.Billing.Usage.type | String | Resource type (Microsoft.Consumption/usageDetails). |
| Azure.Billing.Usage.kind | String | Kind of usage detail (legacy, modern). |
| Azure.Billing.Usage.properties.billingAccountId | String | Billing account identifier. |
| Azure.Billing.Usage.properties.billingAccountName | String | Billing account name. |
| Azure.Billing.Usage.properties.billingPeriodStartDate | Date | Billing period start date. |
| Azure.Billing.Usage.properties.billingPeriodEndDate | Date | Billing period end date. |
| Azure.Billing.Usage.properties.billingProfileId | String | Billing profile identifier. |
| Azure.Billing.Usage.properties.billingProfileName | String | Billing profile name. |
| Azure.Billing.Usage.properties.accountOwnerId | String | Account owner identifier. |
| Azure.Billing.Usage.properties.accountName | String | Account name. |
| Azure.Billing.Usage.properties.subscriptionId | String | Subscription identifier. |
| Azure.Billing.Usage.properties.subscriptionName | String | Subscription name. |
| Azure.Billing.Usage.properties.date | Date | Usage date. |
| Azure.Billing.Usage.properties.product | String | Product name. |
| Azure.Billing.Usage.properties.partNumber | String | Part number for the product. |
| Azure.Billing.Usage.properties.meterId | String | Meter identifier. |
| Azure.Billing.Usage.properties.meterDetails | unknown | Meter details object. |
| Azure.Billing.Usage.properties.meterDetails.meterName | String | Meter name. |
| Azure.Billing.Usage.properties.meterDetails.meterCategory | String | Meter category. |
| Azure.Billing.Usage.properties.meterDetails.meterSubCategory | String | Meter subcategory. |
| Azure.Billing.Usage.properties.meterDetails.unit | String | Unit of measure. |
| Azure.Billing.Usage.properties.meterDetails.meterLocation | String | Meter location. |
| Azure.Billing.Usage.properties.meterDetails.totalIncludedQuantity | Number | Total included quantity. |
| Azure.Billing.Usage.properties.meterDetails.pretaxStandardRate | Number | Pretax standard rate. |
| Azure.Billing.Usage.properties.quantity | Number | Usage quantity. |
| Azure.Billing.Usage.properties.effectivePrice | Number | Effective price for the usage. |
| Azure.Billing.Usage.properties.cost | Number | Cost amount. |
| Azure.Billing.Usage.properties.unitPrice | Number | Unit price. |
| Azure.Billing.Usage.properties.billingCurrency | String | Billing currency. |
| Azure.Billing.Usage.properties.resourceLocation | String | Resource location. |
| Azure.Billing.Usage.properties.consumedService | String | Consumed service name. |
| Azure.Billing.Usage.properties.resourceId | String | Resource identifier. |
| Azure.Billing.Usage.properties.resourceName | String | Resource name. |
| Azure.Billing.Usage.properties.serviceInfo1 | String | Service info 1. |
| Azure.Billing.Usage.properties.serviceInfo2 | String | Service info 2. |
| Azure.Billing.Usage.properties.additionalInfo | String | Additional information. |
| Azure.Billing.Usage.properties.invoiceSection | String | Invoice section. |
| Azure.Billing.Usage.properties.costCenter | String | Cost center. |
| Azure.Billing.Usage.properties.resourceGroup | String | Resource group name. |
| Azure.Billing.Usage.properties.reservationId | String | Reservation identifier. |
| Azure.Billing.Usage.properties.reservationName | String | Reservation name. |
| Azure.Billing.Usage.properties.productOrderId | String | Product order identifier. |
| Azure.Billing.Usage.properties.productOrderName | String | Product order name. |
| Azure.Billing.Usage.properties.offerId | String | Offer identifier. |
| Azure.Billing.Usage.properties.isAzureCreditEligible | Boolean | Whether usage is Azure credit eligible. |
| Azure.Billing.Usage.properties.term | String | Term. |
| Azure.Billing.Usage.properties.publisherName | String | Publisher name. |
| Azure.Billing.Usage.properties.publisherType | String | Publisher type. |
| Azure.Billing.Usage.properties.planName | String | Plan name. |
| Azure.Billing.Usage.properties.chargeType | String | Charge type. |
| Azure.Billing.Usage.properties.frequency | String | Frequency. |
| Azure.Billing.Usage.properties.payGPrice | Number | Pay-as-you-go price. |
| Azure.Billing.Usage.properties.pricingModel | String | Pricing model. |
| Azure.Billing.UsageNextToken | String | Next page token for pagination. |
azure-billing-forecast-list#
Returns cost forecast for a subscription over a given time range. Required permission: Microsoft.CostManagement/forecast/read.
Base Command#
azure-billing-forecast-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| type | Forecast type (required). Possible values are: Usage, ActualCost, AmortizedCost. | Required |
| aggregation_function_name | The name of the column to aggregate (required). Possible values are: PreTaxCostUSD, Cost, CostUSD, PreTaxCost. | Required |
| aggregation_function_type | The name of the aggregation function to use. Default is Sum. | Optional |
| granularity | The granularity of the forecast. Default is Daily. | Optional |
| start_date | Start date for the forecast. Default value current time (UTC). e.g. 2022-01-01T00:00:00Z. | Optional |
| end_date | End date for the forecast. Default value 7 days from current time (UTC). e.g. 2022-01-01T00:00:00Z. | Optional |
| filter | A URL parameter to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. | Optional |
| include_actual_cost | Include actual cost data. Possible values are: true, false. Default is false. | Optional |
| include_fresh_partial_cost | Include fresh partial cost data. Possible values are: true, false. Default is false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Billing.Forecast.Cost | Number | Cost amount. |
| Azure.Billing.Forecast.CostUSD | Number | Cost in USD. |
| Azure.Billing.Forecast.PreTaxCost | Number | Pre-tax cost amount. |
| Azure.Billing.Forecast.UsageDate | String | Usage date for the forecast (YYYY-MM-DD format). |
| Azure.Billing.Forecast.CostStatus | String | Cost status (Forecast, Actual). |
| Azure.Billing.Forecast.Currency | String | Currency code for the forecast. |
azure-billing-budgets-list#
Lists configured budgets at the subscription or resource group level. Required permission: Microsoft.Consumption/budgets/read.
Base Command#
azure-billing-budgets-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| budget_name | Name of the budget. Optional; if provided, returns a specific budget. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Billing.Budget | unknown | List of budget details from Azure Consumption API. |
| Azure.Billing.Budget.id | String | Fully qualified resource ID for the budget. |
| Azure.Billing.Budget.name | String | Name of the budget resource. |
| Azure.Billing.Budget.type | String | Resource type (Microsoft.Consumption/budgets). |
| Azure.Billing.Budget.eTag | String | ETag for the budget resource. |
| Azure.Billing.Budget.properties.category | String | Budget category (Cost, Usage). |
| Azure.Billing.Budget.properties.amount | Number | Budget amount limit. |
| Azure.Billing.Budget.properties.timeGrain | String | Time grain for the budget (Monthly, Quarterly, Annually). |
| Azure.Billing.Budget.properties.timePeriod | unknown | Time period object for the budget. |
| Azure.Billing.Budget.properties.timePeriod.startDate | Date | Start date of the budget period. |
| Azure.Billing.Budget.properties.timePeriod.endDate | Date | End date of the budget period. |
| Azure.Billing.Budget.properties.currentSpend | unknown | Current spend object. |
| Azure.Billing.Budget.properties.currentSpend.amount | Number | Current spend amount. |
| Azure.Billing.Budget.properties.currentSpend.unit | String | Currency unit for current spend. |
| Azure.Billing.Budget.properties.notifications | unknown | Budget notifications configuration. |
| Azure.Billing.Budget.properties.filter | unknown | Budget filter configuration. |
| Azure.Billing.Budget.properties.filter.and | unknown | AND filter conditions. |
| Azure.Billing.Budget.properties.filter.dimensions | unknown | Dimension filters. |
| Azure.Billing.Budget.properties.filter.dimensions.name | String | Dimension name (ResourceGroup, ResourceType, etc.). |
| Azure.Billing.Budget.properties.filter.dimensions.operator | String | Filter operator (In, Equal). |
| Azure.Billing.Budget.properties.filter.dimensions.values | unknown | Filter values array. |
| Azure.Billing.Budget.properties.filter.tags | unknown | Tag filters. |
| Azure.Billing.Budget.properties.filter.tags.name | String | Tag name. |
| Azure.Billing.Budget.properties.filter.tags.operator | String | Tag filter operator. |
| Azure.Billing.Budget.properties.filter.tags.values | unknown | Tag filter values. |
| Azure.Billing.Budget.properties.forecastSpend | unknown | Forecasted spend object. |
| Azure.Billing.Budget.properties.forecastSpend.amount | Number | Forecasted spend amount. |
| Azure.Billing.Budget.properties.forecastSpend.unit | String | Currency unit for forecasted spend. |
azure-storage-container-property-get#
Retrieves properties for a specific Container. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/read.
Base Command#
azure-storage-container-property-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Container. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Container.Property.Last-Modified | Date | Last modified time of the container. |
| Azure.Storage.Container.Property.Etag | String | The entity tag for the container. |
| Azure.Storage.Container.Property.X-Ms-Lease-Status | String | The lease status of the container. |
| Azure.Storage.Container.Property.X-Ms-Lease-State | String | The lease state of the container. |
| Azure.Storage.Container.Property.X-Ms-Has-Immutability-Policy | String | Indicates whether the container has an immutability policy set on it. |
| Azure.Storage.Container.Property.X-Ms-Has-Legal-Hold | String | Indicates whether the container has a legal hold. |
| Azure.Storage.Container.ContainerName | String | Container name. |
azure-storage-container-create#
Creates a new Container under the specified account. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/write.
Base Command#
azure-storage-container-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Container to create. Rules for naming containers can be found here: https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata . | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
There is no context output for this command.
azure-storage-container-delete#
Marks a specific Container for deletion. The Container and any Blobs contained within it will be deleted during garbage collection. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/delete.
Base Command#
azure-storage-container-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Container to delete. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
There is no context output for this command.
azure-storage-container-blob-create#
Create a new Blob under the specified Container. The command is deprecated, please use azure-storage-blob-create. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write.
Base Command#
azure-storage-container-blob-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| file_entry_id | The entry ID of the file to upload as a new blob. Available from the war room while the context data contains file output. | Required |
| blob_name | The name of the Blob to create. Default is the file name | Optional |
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
There is no context output for this command.
azure-storage-container-blob-get#
Retrieve Blob from Container. The command is deprecated, please use azure-storage-blob-get. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read.
Base Command#
azure-storage-container-blob-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the Blob to retrieve. | Required |
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| File.Size | String | The size of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| File.Name | String | The name of the file. |
| File.SSDeep | String | The SSDeep hash of the file. |
| File.EntryID | String | The entry ID of the file. |
| File.Info | String | File information. |
| File.Type | String | The file type. |
| File.MD5 | Unknown | The MD5 hash of the file. |
| File.Extension | String | The file extension. |
azure-storage-container-blob-tag-get#
Retrieve the tags of the specified Blob. The command is deprecated, please use azure-storage-blob-tag-get. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/read.
Base Command#
azure-storage-container-blob-tag-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.StorageContainer.Container.Blob.Tag.Key | String | Tag key. |
| Azure.StorageContainer.Container.Blob.Tag.Value | String | Tag value. |
| Azure.StorageContainer.Container.Blob.name | String | Blob name. |
| Azure.StorageContainer.Container.name | String | Container name. |
azure-storage-container-blob-tag-set#
Sets the tags for the specified Blob. The command replace the entire tags of the Blob and can be used to remove tags. The command is deprecated, please use azure-storage-blob-tag-set. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/read, Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/write.
Base Command#
azure-storage-container-blob-tag-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| tags | Tags fields in JSON format: {"tag-name-1": "tag-value-1", "tag-name-2": "tag-value-2"}. The tags fields may contain at most 10 tags. | Required |
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
There is no context output for this command.
azure-storage-container-blob-property-get#
Retrieve Blob properties. The command is deprecated, please use azure-storage-blob-property-get. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read.
Base Command#
azure-storage-container-blob-property-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.StorageContainer.Container.Blob.Property.last_modified | Date | Last modified time of the blob. |
| Azure.StorageContainer.Container.Blob.Property.etag | String | The entity tag for the blob. |
| Azure.StorageContainer.Container.Blob.Property.lease_status | String | The lease status of the blob. |
| Azure.StorageContainer.Container.Blob.Property.lease_state | String | The lease state of the blob. |
| Azure.StorageContainer.Container.Blob.Property.blob_type | String | The blob type. |
| Azure.StorageContainer.Container.Blob.Property.content_length | Number | The size of the blob in bytes. |
| Azure.StorageContainer.Container.Blob.Property.content_type | String | The content type specified for the blob. If no content type was specified, the default content type is application/octet-stream. |
| Azure.StorageContainer.Container.Blob.Property.content-md5 | String | The MD5 hash of the blob content. |
| Azure.StorageContainer.Container.Blob.Property.creation_time | Date | The date at which the blob was created. |
| Azure.StorageContainer.Container.Blob.name | String | Blob name. |
azure-storage-container-blob-property-set#
Set Blob properties. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write.
Base Command#
azure-storage-container-blob-property-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| subscription_id | The subscription ID. | Required |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| content_type | Blob content type. Indicates the media type of the blob. | Optional |
| content_md5 | Blob MD5 hash value. Can be used by the client to check for content integrity. | Optional |
| content_encoding | Blob content encoding. Used to specify the compression algorithm of the blob content. | Optional |
| content_language | Blob content language. Describes the human languages of the blob content. | Optional |
| content_disposition | Blob content disposition. Conveys additional information about how to process the response payload, and also can be used to attach additional metadata. | Optional |
| cache_control | Modifies the cache control string for the blob. Indicates directives for caching in both requests and responses. | Optional |
| request_id | Request ID generated by the client and recorded in the analytics logs when storage analytics logging is enabled. | Optional |
| lease_id | Required if the blob has an active lease. | Optional |
Context Output#
There is no context output for this command.
azure-storage-container-public-access-block#
Blocks public access to a container. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/setAcl/action.
Base Command#
azure-storage-container-public-access-block
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | Name of a container. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
There is no context output for this command.
azure-storage-blob-property-get#
Retrieve Blob properties. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read.
Base Command#
azure-storage-blob-property-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Blob.Property.Last-Modified | Date | Last modified time of the blob. |
| Azure.Storage.Blob.Property.Etag | String | The entity tag for the blob. |
| Azure.Storage.Blob.Property.X-Ms-Lease-Status | String | The lease status of the blob. |
| Azure.Storage.Blob.Property.X-Ms-Lease-State | String | The lease state of the blob. |
| Azure.Storage.Blob.Property.X-Ms-Blob-Type | String | The blob type. |
| Azure.Storage.Blob.Property.Content-Type | String | The content type specified for the blob. If no content type was specified, the default content type is application/octet-stream. |
| Azure.Storage.Blob.Property.Content-Md5 | String | The MD5 hash of the blob content. |
| Azure.Storage.Blob.Property.X-Ms-Creation-Time | String | The date at which the blob was created. |
| Azure.Storage.Blob.Property.Server | String | The server used to process the request. |
| Azure.Storage.Blob.Property.Accept-Ranges | String | Indicates that the service supports requests for partial blob content. |
| Azure.Storage.Blob.Property.Connection | String | The connection status of the response. |
| Azure.Storage.Blob.Property.Date | String | A UTC date/time value generated by the service that indicates the time when the response was initiated. |
| Azure.Storage.Blob.Property.Transfer-Encoding | String | The form of encoding used to safely transfer the payload to the user. |
| Azure.Storage.Blob.Property.X-Ms-Access-Tier | String | The tier of page blob on a Premium Storage account or tier of a block blob in a Blob Storage or general purpose v2 account. |
| Azure.Storage.Blob.Property.X-Ms-Access-Tier-Inferred | String | For page blobs on a Premium Storage account only. If the access tier isn't explicitly set on the blob, the tier is inferred based on its content length, and this header is returned with a value of true. |
| Azure.Storage.Blob.Property.X-Ms-Request-Id | String | This header uniquely identifies the request that was made. |
| Azure.Storage.Blob.Property.X-Ms-Server-Encrypted | String | The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. |
| Azure.Storage.Blob.Property.X-Ms-Version | String | Specifies the version of the operation to use for this request. |
| Azure.Storage.Blob.name | String | Blob name. |
| Azure.Storage.Blob.ContainerName | String | Container name. |
azure-storage-blob-tag-get#
Retrieve the tags of the specified Blob. Required Permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/read.
Base Command#
azure-storage-blob-tag-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Blob.Tag.Key | String | Tag key. |
| Azure.Storage.Blob.Tag.Value | String | Tag value. |
| Azure.Storage.Blob.name | String | Blob name. |
| Azure.Storage.Blob.ContainerName | String | Container name. |
azure-compute-vm-create#
Creates a virtual machine instance with the specified OS image. Required permissions: Microsoft.Compute/virtualMachines/write.
Base Command#
azure-compute-vm-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group to which the new virtual machine will belong. | Required |
| virtual_machine_name | The name of the virtual machine to create. | Required |
| virtual_machine_location | The location in which to create the virtual machine. Possible values are: westus2, westus, westindia, westeurope, westcentralus, uksouth, ukwest, southeastasia, northcentralus, northeurope, southcentralus, southindia, francesouth, francecentral, japaneast, japanwest, koreacentral, koreasouth, brazilsouth, canadacentral, canadaeast, centralindia, eastus2, eastasia, centralus, eastus, australiacentral, australiacentral2, australiaeast, australiasoutheast. | Required |
| nic_name | The name of the Network Interface to link the virtual machine. Note that the virtual machine's location property must match that of the Network Interface to which it is linked. | Required |
| vm_size | The name of a VirtualMachineSize object, which determines the size of the deployed virtual machine. Possible values are: Standard_D1_v2, Standard_D2_v2, Standard_D2s_v3, Standard_B1ms, Standard_B1s, Standard_B2s, Standard_B4ms, Standard_D4s_v3, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Promo_DS2_v2, Promo_DS3_v2. | Required |
| os_image | The base operating system image of the virtual machine. It is mandatory to provide either this argument or the sku, publisher, version, and offer arguments. Possible values are: Ubuntu Server 14.04 LTS, Ubuntu Server 16.04 LTS, Ubuntu Server 18.04 LTS, Red Hat Enterprise Linux 7.6, CentOS-based 7.5, Windows Server 2012 R2 Datacenter, Windows Server 2016 Datacenter, Windows 10 Pro Version 1803, Windows 10 Pro Version 1809. | Optional |
| sku | The SKU of the OS image to use. Default is 2016-Datacenter. | Optional |
| publisher | The name of the publisher of the OS image. Default is MicrosoftWindowsServer. | Optional |
| version | The version of the image to use. Supported formats are Major.Minor.Build or latest. Default is latest. | Optional |
| offer | The offer of the platform image or marketplace image used to create the virtual machine. Default is WindowsServer. | Optional |
| admin_username | The admin username to use when creating the virtual machine. | Optional |
| admin_password | The admin password to use when creating the virtual machine. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.VirtualMachines.id | String | The ID of the virtual machine. |
| Azure.Compute.VirtualMachines.name | String | The name of the virtual machine. |
| Azure.Compute.VirtualMachines.type | String | The type of the virtual machine. |
| Azure.Compute.VirtualMachines.location | String | The location of the virtual machine. |
| Azure.Compute.VirtualMachines.tags | Unknown | The tags of the virtual machine. |
| Azure.Compute.VirtualMachines.etag | String | The ETag of the virtual machine, used to prevent overwriting concurrent updates. |
| Azure.Compute.VirtualMachines.extendedLocation | Unknown | The extended location of the virtual machine. |
| Azure.Compute.VirtualMachines.identity | Unknown | The identity of the virtual machine, if configured. |
| Azure.Compute.VirtualMachines.managedBy | String | The ARM resource ID of the Virtual Machine Scale Set (VMSS) that manages the virtual machine, if applicable. |
| Azure.Compute.VirtualMachines.placement | Unknown | The user-defined constraints for virtual machine hardware placement. This property cannot be changed once the virtual machine is provisioned. |
| Azure.Compute.VirtualMachines.plan | Unknown | The information about the marketplace image used to create the virtual machine. |
| Azure.Compute.VirtualMachines.plan.name | String | The plan name. |
| Azure.Compute.VirtualMachines.plan.publisher | String | The publisher of the plan. |
| Azure.Compute.VirtualMachines.plan.product | String | The product of the plan. |
| Azure.Compute.VirtualMachines.plan.promotionCode | String | The promotion code of the plan. |
| Azure.Compute.VirtualMachines.systemData | Unknown | The Azure Resource Manager metadata containing the createdBy and modifiedBy information. |
| Azure.Compute.VirtualMachines.zones | Unknown | The availability zones of the virtual machine. |
| Azure.Compute.VirtualMachines.resources | Unknown | The virtual machine child extension resources. |
| Azure.Compute.VirtualMachines.properties.vmId | String | The unique ID of the virtual machine. |
| Azure.Compute.VirtualMachines.properties.provisioningState | String | The provisioning state, which only appears in the response. |
| Azure.Compute.VirtualMachines.properties.timeCreated | Date | The time when the virtual machine was created. |
| Azure.Compute.VirtualMachines.properties.hardwareProfile | Unknown | The hardware settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.storageProfile | Unknown | The storage settings for the virtual machine disks. |
| Azure.Compute.VirtualMachines.properties.osProfile | Unknown | The operating system settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.networkProfile | Unknown | The network interfaces of the virtual machine. |
| Azure.Compute.VirtualMachines.properties.additionalCapabilities | Unknown | The additional capabilities enabled or disabled on the virtual machine. |
| Azure.Compute.VirtualMachines.properties.securityProfile | Unknown | The security settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.diagnosticsProfile | Unknown | The boot diagnostic settings state. |
| Azure.Compute.VirtualMachines.properties.availabilitySet | Unknown | The availability set that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.virtualMachineScaleSet | Unknown | The virtual machine scale set that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.proximityPlacementGroup | Unknown | The proximity placement group that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.scheduledEventsPolicy | Unknown | The Redeploy, Reboot, and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.scheduledEventsProfile | Unknown | The scheduled event related configurations. |
| Azure.Compute.VirtualMachines.properties.priority | String | The priority for the virtual machine. Possible values are Regular, Low, or Spot. |
| Azure.Compute.VirtualMachines.properties.evictionPolicy | String | The eviction policy for the Azure Spot virtual machine. Possible values are Deallocate or Delete. |
| Azure.Compute.VirtualMachines.properties.billingProfile | Unknown | The billing related details of an Azure Spot virtual machine. |
| Azure.Compute.VirtualMachines.properties.host | Unknown | The dedicated host that the virtual machine resides in. |
| Azure.Compute.VirtualMachines.properties.hostGroup | Unknown | The dedicated host group that the virtual machine resides in. |
| Azure.Compute.VirtualMachines.properties.licenseType | String | The license type for the bring your own license scenario. |
| Azure.Compute.VirtualMachines.properties.extensionsTimeBudget | String | The time allotted for all extensions to start, in ISO 8601 format. |
| Azure.Compute.VirtualMachines.properties.platformFaultDomain | Number | The scale set logical fault domain into which the virtual machine is created. |
| Azure.Compute.VirtualMachines.properties.userData | String | The user data for the virtual machine, which must be base-64 encoded. |
| Azure.Compute.VirtualMachines.properties.capacityReservation | Unknown | The capacity reservation related details of the virtual machine. |
| Azure.Compute.VirtualMachines.properties.applicationProfile | Unknown | The gallery applications that should be made available to the virtual machine. |
| Azure.Compute.VirtualMachines.properties.instanceView | Unknown | The virtual machine instance view. |
azure-compute-vm-delete#
Deallocates and deletes a specified virtual machine. Required permissions: Microsoft.Compute/virtualMachines/deallocate/action, Microsoft.Compute/virtualMachines/delete.
Base Command#
azure-compute-vm-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group to which the virtual machine belongs. | Required |
| virtual_machine_name | The name of the virtual machine to delete. To see all the virtual machines with their associated names for a specific resource group, run the azure-compute-vm-list command. | Required |
Context Output#
There is no context output for this command.
azure-compute-vm-list#
Lists all the virtual machines in the specified subscription. Use the next_token argument to view the next page of results. Required Permissions: Microsoft.Compute/virtualMachines/read.
Base Command#
azure-compute-vm-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| next_token | The URI to fetch the next page of results. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.VirtualMachines.type | String | The type of the resource. |
| Azure.Compute.VirtualMachines.location | String | The location of the resource. |
| Azure.Compute.VirtualMachines.tags | Unknown | The tags of the resource. |
| Azure.Compute.VirtualMachines.id | String | The ID of the resource. |
| Azure.Compute.VirtualMachines.name | String | The name of the resource. |
| Azure.Compute.VirtualMachines.etag | String | The ETag of the virtual machine, used to prevent overwriting concurrent updates. |
| Azure.Compute.VirtualMachines.extendedLocation | Unknown | The extended location of the Virtual Machine. |
| Azure.Compute.VirtualMachines.identity | Unknown | The identity of the virtual machine, if configured. |
| Azure.Compute.VirtualMachines.managedBy | Unknown | MThe ARM resource ID of the Virtual Machine Scale Set (VMSS) that manages the virtual machine, if applicable. Used for internal resource group delete optimization. |
| Azure.Compute.VirtualMachines.placement | Unknown | The user-defined constraints for virtual machine hardware placement. This property cannot be changed once the VM is provisioned. Minimum api-version: 2024-11-01. |
| Azure.Compute.VirtualMachines.plan | Unknown | Information about the marketplace image used to create the virtual machine. |
| Azure.Compute.VirtualMachines.systemData | Unknown | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| Azure.Compute.VirtualMachines.zones | Unknown. | The availability zones. |
| Azure.Compute.VirtualMachines.properties.vmId | String | The unique ID of the virtual machine. |
| Azure.Compute.VirtualMachines.properties.availabilitySet | String | The availability set that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.hardwareProfile | Unknown | The hardware settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.storageProfile | Unknown | The storage settings for the virtual machine disks. |
| Azure.Compute.VirtualMachines.properties.osProfile | Unknown | The operating system settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.networkProfile | Unknown | The network interfaces of the virtual machine. |
| Azure.Compute.VirtualMachines.properties.provisioningState | String | The provisioning state, which only appears in the response. |
| Azure.Compute.VirtualMachines.properties.additionalCapabilities | Unknown | Additional capabilities enabled or disabled on the virtual machine. |
| Azure.Compute.VirtualMachines.properties.securityProfile | Unknown | The security settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.diagnosticsProfile | Unknown | The boot diagnostic settings state. |
| Azure.Compute.VirtualMachines.properties.virtualMachineScaleSet | Unknown | The virtual machine scale set that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.proximityPlacementGroup | Unknown | The proximity placement group that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.scheduledEventsPolicy | Unknown | The Redeploy, Reboot, and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.priority | String | The priority for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.evictionPolicy | String | The eviction policy for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.billingProfile | Unknown | The billing related details of a Azure Spot virtual machine. |
| Azure.Compute.VirtualMachines.properties.host | Unknown | The host that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.hostGroup | Unknown | The host group that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.licenseType | String | The license type for bringing your own license scenario. |
| Azure.Compute.VirtualMachines.properties.extensionsTimeBudget | String | The time alloted for all extensions to start. |
| Azure.Compute.VirtualMachines.properties.platformFaultDomain | Number | The fault domain that the virtual machine is in. |
| Azure.Compute.VirtualMachines.properties.scheduledEventsProfile | Unknown | The scheduled event related configurations. |
| Azure.Compute.VirtualMachines.properties.userData | String | The user data for the VM, which must be base-64 encoded. |
| Azure.Compute.VirtualMachines.properties.capacityReservation | Unknown | The capacity reservation related details of a virtual machine. |
| Azure.Compute.VirtualMachines.properties.applicationProfile | Unknown | The gallery applications that should be made available to the VM/VMSS. |
| Azure.Compute.VirtualMachines.properties.timeCreated | Date | The time when the virtual machine was created. |
| Azure.Compute.VirtualMachines.plan.name | String | The plan name. |
| Azure.Compute.VirtualMachines.plan.publisher | String | The publisher of the plan. |
| Azure.Compute.VirtualMachines.plan.product | String | The product of the plan. |
| Azure.Compute.VirtualMachines.plan.promotionCode | String | The promotion code of the plan. |
| Azure.Compute.VirtualMachines.resources.properties | Unknown | The properties of the resource. |
| Azure.Compute.VirtualMachines.resources.id | String | The ID of the resource. |
| Azure.Compute.VirtualMachines.resources.name | String | The name of the resource. |
| Azure.Compute.VirtualMachines.resources.type | String | The type of the resource. |
| Azure.Compute.VirtualMachines.resources.location | String | The location of the resource. |
| Azure.Compute.VirtualMachines.resources.tags | Unknown | The tags of the resource. |
| Azure.Compute.VirtualMachines.identity.principalId | String | The principal ID of the identity. |
| Azure.Compute.VirtualMachines.identity.tenantId | String | The tenant ID of the identity. |
| Azure.Compute.VirtualMachines.identity.type | String | The type of the identity. |
| Azure.Compute.VirtualMachines.identity.userAssignedIdentities | String | The list of user assigned identities associated with the virtual machine. |
| Azure.Compute.VirtualMachines.zones | String | The zones of the virtual machine. |
| Azure.Compute.VirtualMachines.extendedLocation.name | String | The name of the extended location. |
| Azure.Compute.VirtualMachines.extendedLocation.type | String | The type of the extended location. |
| Azure.Compute.VirtualMachines.properties.instanceView | Unknown | The virtual machine instance view. |
| Azure.Compute.VirtualMachinesNextToken | String | The URI to fetch the next page of VMs. Run the same command with the next_token argument to get the next page of VMs. |
azure-compute-vm-get#
Gets the properties of a given virtual machine. Required Permissions: Microsoft.Compute/virtualMachines/read.
Base Command#
azure-compute-vm-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group to which the virtual machine belongs. | Required |
| virtual_machine_name | The name of the virtual machine you want to view the details of. To see all the virtual machines with their associated names for a specific resource group, run the azure-compute-vm-list command. | Required |
| expand | The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation. Possible values are: instanceView, userData, resiliencyView. Default is instanceView. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.VirtualMachines.name | string | The name of the virtual machine you want to get details of. |
| Azure.Compute.VirtualMachines.id | string | The ID of the virtual machine. |
| Azure.Compute.VirtualMachines.location | string | The region in which the virtual machine is hosted. |
| Azure.Compute.VirtualMachines.properties.provisioningState | string | The provisioning state of the deployed virtual machine. |
| Azure.Compute.VirtualMachines.networkProfile.networkInterfaces | string | The list of network interfaces attached to this virtual machine. |
| Azure.Compute.VirtualMachines.properties.hardwareProfile | Unknown | Specifies the hardware settings for the virtual machine. |
| Azure.Compute.VirtualMachines.properties.osProfile | string | The operating system configuration of the virtual machine, including admin credentials and hostname. |
| Azure.Compute.VirtualMachines.properties.storageProfile | string | The storage settings for the virtual machine, including OS and data disks. |
| Azure.Compute.VirtualMachines.properties.vmId | string | The unique identifier assigned to the virtual machine instance. |
| Azure.Compute.VirtualMachines.properties.instanceView | string | Detailed runtime status information about the virtual machine, such as power state and extensions. |
| Azure.Compute.VirtualMachines.properties.timeCreated | string | The timestamp when the virtual machine was created. |
| Azure.Compute.VirtualMachines.properties.networkProfile | string | The network configuration of the virtual machine, including associated network interfaces and settings. |
| Azure.Compute.VirtualMachines.properties.diagnosticsProfile | string | The configuration for boot diagnostics and monitoring of the virtual machine. |
azure-vn-security-group-create#
Creates a network security group. Required Permissions: Microsoft.Network/networkSecurityGroups/write.
Base Command#
azure-vn-security-group-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| security_group_name | The name of the network security group. | Required |
| location | The location of the network security group. Possible values are: australiacentral, australiacentral2, australiaeast, australiasoutheast, brazilsouth, brazilsoutheast, brazilus, canadacentral, canadaeast, centralindia, centralus, centraluseuap, eastasia, eastus, eastus2, eastus2euap, francecentral, francesouth, germanynorth, germanywestcentral, israelcentral, italynorth, japaneast, japanwest, jioindiacentral, jioindiawest, koreacentral, koreasouth, malaysiasouth, mexicocentral, newzealandnorth, northcentralus, northeurope, norwayeast, norwaywest, polandcentral, qatarcentral, southafricanorth, southafricawest, southcentralus, southeastasia, southindia, spaincentral, swedencentral, swedensouth, switzerlandnorth, switzerlandwest, uaecentral, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2, westus3, australiaeastfoundational, austriaeast, chilecentral, eastusslv, indonesiacentral, israelnorthwest, malaysiawest, southcentralus2, southeastus, southeastus3, southwestus, usgovarizona, usgovtexas, usgovvirginia. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.SecurityGroups.name | String | The security group's name. |
| Azure.VirtualNetworks.SecurityGroups.id | String | The security group's ID. |
| Azure.VirtualNetworks.SecurityGroups.etag | String | The security group's ETag. |
| Azure.VirtualNetworks.SecurityGroups.type | String | The resource type. |
| Azure.VirtualNetworks.SecurityGroups.location | String | The resource location. |
| Azure.VirtualNetworks.SecurityGroups.properties.provisioningState | String | The provisioning state of the network security group resource. |
| Azure.VirtualNetworks.SecurityGroups.properties.resourceGuid | String | The resource GUID property of the network security group resource. |
| Azure.VirtualNetworks.SecurityGroups.properties.flushConnection | Boolean | When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. |
| Azure.VirtualNetworks.SecurityGroups.properties.securityRules | Unknown | A collection of security rules of the network security group. |
| Azure.VirtualNetworks.SecurityGroups.properties.defaultSecurityRules | Unknown | A collection of the default security rules of the network security group. |
| Azure.VirtualNetworks.SecurityGroups.properties.flowLogs | Unknown | A collection of references to flow log resources. |
| Azure.VirtualNetworks.SecurityGroups.properties.networkInterfaces | Unknown | A collection of references to network interfaces. |
| Azure.VirtualNetworks.SecurityGroups.properties.subnets | Unknown | A collection of references to subnets. |
azure-compute-vm-power-off#
Powers off a given virtual machine. Required Permissions: Microsoft.Compute/virtualMachines/poweroff/action.
Base Command#
azure-compute-vm-power-off
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group to which the virtual machine belongs. To see all the resource groups associated with your subscription, run the azure-rm-resource-groups-list command. | Required |
| virtual_machine_name | The name of the virtual machine to power off. To see all virtual machines with their associated names for a specific resource group, run the azure-compute-vm-list command. | Required |
| skip_shutdown | Set to True to request non-graceful VM shutdown. Possible values are: true, false. Default is false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.VirtualMachines.name | string | The name of the virtual machine that was powered off. |
| Azure.Compute.VirtualMachines.resourceGroup | string | The resource group in which the virtual machine resides. |
| Azure.Compute.VirtualMachines.powerState | string | Whether the virtual machine instance is powered on or off. |
azure-compute-vm-start#
Powers on a given virtual machine. Required Permissions: Microsoft.Compute/virtualMachines/start/action.
Base Command#
azure-compute-vm-start
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | Resource Group to which the virtual machine belongs. | Required |
| virtual_machine_name | Name of the virtual machine to power on. To see all virtual machines and their associated names for a specific resource group, run the azure-compute-vm-list command. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.VirtualMachines.name | String | Name of the VM that was started. |
| Azure.Compute.VirtualMachines.resourceGroup | String | Resource group the VM resides in. |
| Azure.Compute.VirtualMachines.powerState | String | Whether the VM instance is powered on or off. |
azure-cosmosdb-db-account-update#
Updates the properties of an existing Azure Cosmos DB database account. The required permissions are: Microsoft.DocumentDB/databaseAccounts/read, Microsoft.DocumentDB/databaseAccounts/write.
Base Command#
azure-cosmosdb-db-account-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| account_name | Cosmos DB database account name. | Required |
| disable_key_based_metadata_write_access | Whether to disable write operations on metadata resources via account keys. Possible values are: true, false. | Optional |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.CosmosDB.DBAccounts.id | String | The unique resource identifier of the ARM resource. |
| Azure.CosmosDB.DBAccounts.name | String | The name of the ARM resource. |
| Azure.CosmosDB.DBAccounts.location | String | The location of the resource group to which the resource belongs. |
| Azure.CosmosDB.DBAccounts.kind | String | The database account type. |
| Azure.CosmosDB.DBAccounts.identity.type | String | The type of identity used for the resource. |
| Azure.CosmosDB.DBAccounts.identity.userAssignedIdentities | Unknown | The list of user identities associated with the resource. |
| Azure.CosmosDB.DBAccounts.properties.analyticalStorageConfiguration | Unknown | Analytical storage specific properties. |
| Azure.CosmosDB.DBAccounts.properties.apiProperties | Unknown | API specific properties. |
| Azure.CosmosDB.DBAccounts.properties.backupPolicy | Unknown | The policy for taking backups on an account. |
| Azure.CosmosDB.DBAccounts.properties.capabilities | Unknown | List of Cosmos DB capabilities for the account. |
| Azure.CosmosDB.DBAccounts.properties.capacity | Number | Properties related to capacity enforcement on an account. |
| Azure.CosmosDB.DBAccounts.properties.connectorOffer | String | The Cassandra connector offer type for the Cosmos DB database account. |
| Azure.CosmosDB.DBAccounts.properties.consistencyPolicy | String | The consistency policy for the Cosmos DB database account. |
| Azure.CosmosDB.DBAccounts.properties.cors | Unknown | The CORS policy for the Cosmos DB database account. |
| Azure.CosmosDB.DBAccounts.properties.createMode | String | The mode of account creation. |
| Azure.CosmosDB.DBAccounts.properties.customerManagedKeyStatus | String | Status of the Customer Managed Key feature on the account. |
| Azure.CosmosDB.DBAccounts.properties.databaseAccountOfferType | String | The offer type for the Cosmos DB database account. |
| Azure.CosmosDB.DBAccounts.properties.defaultIdentity | String | The default identity for accessing key vault used in features like customer managed keys. |
| Azure.CosmosDB.DBAccounts.properties.disableKeyBasedMetadataWriteAccess | Boolean | Whether write operations on metadata resources via account keys is disabled. |
| Azure.CosmosDB.DBAccounts.properties.disableLocalAuth | Boolean | Whether local authentication is disabled. |
| Azure.CosmosDB.DBAccounts.properties.documentEndpoint | String | The connection endpoint for the Cosmos DB database account. |
| Azure.CosmosDB.DBAccounts.properties.enableAnalyticalStorage | Boolean | Whether storage analytics are enabled. |
| Azure.CosmosDB.DBAccounts.properties.enableAutomaticFailover | Boolean | Enables automatic failover of the write region. |
| Azure.CosmosDB.DBAccounts.properties.enableBurstCapacity | Boolean | Whether Burst Capacity is enabled. |
| Azure.CosmosDB.DBAccounts.properties.enableCassandraConnector | Boolean | Enables the Cassandra connector on the Cosmos DB account. |
| Azure.CosmosDB.DBAccounts.properties.enableFreeTier | Boolean | Whether Free Tier is enabled. |
| Azure.CosmosDB.DBAccounts.properties.enableMultipleWriteLocations | Boolean | Enables the account to write in multiple locations. |
| Azure.CosmosDB.DBAccounts.properties.enablePartitionMerge | Boolean | Whether Partition Merge is enabled. |
| Azure.CosmosDB.DBAccounts.properties.enablePerRegionPerPartitionAutoscale | Boolean | Whether PerRegionPerPartitionAutoscale is enabled. |
| Azure.CosmosDB.DBAccounts.properties.failoverPolicies | Unknown | An array that contains the regions ordered by their failover priorities. |
| Azure.CosmosDB.DBAccounts.properties.instanceId | String | A unique identifier assigned to the database account. |
| Azure.CosmosDB.DBAccounts.properties.ipRules | Unknown | List of IP rules. |
| Azure.CosmosDB.DBAccounts.properties.isVirtualNetworkFilterEnabled | Boolean | Whether the Virtual Network ACL rules are enabled. |
| Azure.CosmosDB.DBAccounts.properties.keyVaultKeyUri | String | The URI of the key vault. |
| Azure.CosmosDB.DBAccounts.properties.keysMetadata | Unknown | Metadata related to each access key for the given Cosmos DB database account. |
| Azure.CosmosDB.DBAccounts.properties.locations | Unknown | An array that contains all of the locations enabled for the Cosmos DB account. |
| Azure.CosmosDB.DBAccounts.properties.minimalTlsVersion | String | The minimum allowed TLS version. |
| Azure.CosmosDB.DBAccounts.properties.networkAclBypass | String | Which services are allowed to bypass firewall checks. |
| Azure.CosmosDB.DBAccounts.properties.networkAclBypassResourceIds | Unknown | List of resource IDs that are allowed to bypass firewall checks. |
| Azure.CosmosDB.DBAccounts.properties.privateEndpointConnections | Unknown | List of private endpoint connections. |
| Azure.CosmosDB.DBAccounts.properties.provisioningState | String | The status of the Cosmos DB account at the time the operation was called. |
| Azure.CosmosDB.DBAccounts.properties.readLocations | Unknown | An array that contains the read locations enabled for the Cosmos DB account. |
| Azure.CosmosDB.DBAccounts.properties.virtualNetworkRules | Unknown | List of Virtual Network ACL rules. |
| Azure.CosmosDB.DBAccounts.properties.writeLocations | Unknown | An array that contains the write locations enabled for the Cosmos DB account. |
azure-keyvault-vault-update#
Updates a key vault in the specified subscription. The required permissions are: Microsoft.KeyVault/vaults/read, Microsoft.KeyVault/vaults/write.
Base Command#
azure-keyvault-vault-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| vault_name | Key Vault name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| enable_purge_protection | Whether protection against purge is enabled for this vault. This functionality is always enabled, it cannot be disabled. Possible values are: true, false. | Optional |
| enable_soft_delete | Whether soft delete is enabled for this key vault. This functionality is always enabled, it cannot be disabled. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.KeyVault.Vault.id | String | Resource ID. |
| Azure.KeyVault.Vault.name | String | Key Vault name. |
| Azure.KeyVault.Vault.type | String | Resource type in Azure. |
| Azure.KeyVault.Vault.location | String | Key Vault location. |
| Azure.KeyVault.Vault.tags | Unknown | Resource tags. |
| Azure.KeyVault.Vault.properties.sku | String | SKU details. |
| Azure.KeyVault.Vault.properties.tenantId | String | The Entra ID tenant ID that should be used for authenticating requests to the key vault. |
| Azure.KeyVault.Vault.properties.accessPolicies | Unknown | An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. |
| Azure.KeyVault.Vault.properties.enabledForDeployment | Boolean | Whether Azure Virtual Machines are allowed to retrieve certificates stored as secrets from the key vault. |
| Azure.KeyVault.Vault.properties.enabledForDiskEncryption | Boolean | Whether Azure Disk Encryption is allowed to retrieve secrets from the vault and unwrap keys. |
| Azure.KeyVault.Vault.properties.enabledForTemplateDeployment | Boolean | Whether Azure Resource Manager is allowed to retrieve secrets from the key vault. |
| Azure.KeyVault.Vault.properties.enableSoftDelete | Boolean | Whether soft delete is enabled for this key vault. |
| Azure.KeyVault.Vault.properties.enablePurgeProtection | Boolean | Whether purge protection is enabled for this key vault. |
| Azure.KeyVault.Vault.properties.enableRbacAuthorization | Boolean | Whether Azure Key Vault uses Role Based Access Control, RBAC, for authorization of data actions. |
| Azure.KeyVault.Vault.properties.vaultUri | String | The URI of the vault for performing operations on keys and secrets. |
| Azure.KeyVault.Vault.properties.provisioningState | String | The current provisioning state. |
| Azure.KeyVault.Vault.properties.privateEndpointConnections | Unknown | List of private endpoint connections associated with the key vault. |
| Azure.KeyVault.Vault.properties.networkAcls | Unknown | Rules governing the accessibility of the key vault from specific network locations. |
azure-rm-resource-groups-list#
Gets all resource groups for a subscription. Required Permissions: Microsoft.Resources/subscriptions/resourceGroups/read.
Base Command#
azure-rm-resource-groups-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| limit | Limit on the number of resource groups to return. Default is 50. | Optional |
| tag | A single tag in the form of {"Tag Name":"Tag Value"} to filter the list by. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ResourceManagement.ResourceGroups.id | String | The unique identifier of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.name | String | The name of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.type | String | The type of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.location | String | The location of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.properties.provisioningState | String | The provisioning state of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.tags.Owner | String | The owner tag of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.tags | Unknown | The tags associated with the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.tags.Name | String | The name tag of the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.managedBy | String | The entity that manages the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.tags.aNSG-managed-cluster-name | String | The ANSG managed cluster name tag associated with the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.tags.aNSG-managed-cluster-rg | String | The ANSG managed cluster resource group tag associated with the Azure Network Security Groups resource group. |
| Azure.ResourceManagement.ResourceGroups.tags.type | String | The type tag associated with the Azure Network Security Groups resource group. |
azure-sqldb-security-alert-policy-update#
Updates a database's security alert policy. The required permissions are: Microsoft.Sql/servers/databases/securityAlertPolicies/read, Microsoft.Sql/servers/databases/securityAlertPolicies/write.
Base Command#
azure-sqldb-security-alert-policy-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| server_name | Server name. | Required |
| db_name | Database name. | Required |
| email_account_admins_enabled | Whether the alert is sent to the account administrators. Possible values are: true, false. | Optional |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.SqlDB.SecurityAlertPolicies.id | String | Threat policy ID. |
| Azure.SqlDB.SecurityAlertPolicies.name | String | Threat policy name. |
| Azure.SqlDB.SecurityAlertPolicies.properties.state | String | Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. |
| Azure.SqlDB.SecurityAlertPolicies.properties.creationTime | String | Specifies the UTC creation time of the policy. |
| Azure.SqlDB.SecurityAlertPolicies.properties.retentionDays | Number | Specifies the number of days to keep in the Threat Detection audit logs. |
| Azure.SqlDB.SecurityAlertPolicies.properties.storageAccountAccessKey | String | Specifies the identifier key of the Threat Detection audit storage account. |
| Azure.SqlDB.SecurityAlertPolicies.properties.storageEndpoint | String | Specifies the blob storage endpoint. |
| Azure.SqlDB.SecurityAlertPolicies.properties.emailAccountAdmins | Boolean | Specifies that the alert is sent to the account administrators. |
| Azure.SqlDB.SecurityAlertPolicies.properties.emailAddresses | String | Specifies an array of e-mail addresses to which the alert is sent. |
| Azure.SqlDB.SecurityAlertPolicies.properties.disabledAlerts | Unknown | Specifies an array of alerts that are disabled. |
| Azure.SqlDB.SecurityAlertPolicies.systemData.createdAt | Unknown | The timestamp of resource creation (UTC). |
| Azure.SqlDB.SecurityAlertPolicies.systemData.createdBy | Unknown | The identity that created the resource. |
| Azure.SqlDB.SecurityAlertPolicies.systemData.createdByType | Unknown | The type of identity that created the resource. |
| Azure.SqlDB.SecurityAlertPolicies.systemData.lastModifiedAt | Unknown | The timestamp of resource last modification (UTC). |
| Azure.SqlDB.SecurityAlertPolicies.systemData.lastModifiedBy | Unknown | The identity that last modified the resource. |
| Azure.SqlDB.SecurityAlertPolicies.systemData.lastModifiedByType | Unknown | The type of identity that last modified the resource. |
azure-vn-network-interfaces-list#
Gets network interfaces in a resource group. Required permissions: Microsoft.Network/networkInterfaces/read.
Base Command#
azure-vn-network-interfaces-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| limit | The maximum number of records to return. Default is 50. | Optional |
| all_results | Whether to retrieve all results by overriding the default limit. Possible values are: false, true. Default is false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.NetworkInterfaces.name | String | The network interface's name. |
| Azure.VirtualNetworks.NetworkInterfaces.id | String | The network interface's ID. |
| Azure.VirtualNetworks.NetworkInterfaces.kind | String | The kind of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.etag | String | The ETag of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.location | String | The location of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.managedBy | String | The entity that manages the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.tags | String | The tags associated with the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.provisioningState | String | The network interface's provisioning state. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.ipConfigurations | Unknown | A list of IPConfigurations of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.tapConfigurations | List | List of tap configurations. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.allowPort25Out | Boolean | Whether port 25 outbound traffic is allowed. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.nicType | String | The network interface card type (Standard/Basic). |
azure-vn-public-ip-addresses-list#
Gets public IP addresses in a resource group. Required permissions: Microsoft.Network/publicIPAddresses/read.
Base Command#
azure-vn-public-ip-addresses-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| limit | The maximum number of records to return. Default is 50. | Optional |
| all_results | Whether to retrieve all results by overriding the default limit. Possible values are: false, true. Default is false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.PublicIPAddresses.name | String | The public IP address's name. |
| Azure.VirtualNetworks.PublicIPAddresses.id | String | The public IP address's ID. |
| Azure.VirtualNetworks.PublicIPAddresses.location | String | The location of the public IP address. |
| Azure.VirtualNetworks.PublicIPAddresses.sku | String | The public IP address's SKU. |
| Azure.VirtualNetworks.PublicIPAddresses.type | String | The type of the public IP address. |
| Azure.VirtualNetworks.PublicIPAddresses.etag | String | The public IP address's ETag. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.provisioningState | String | The public IP address's provisioning state. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.publicIPAddressVersion | String | The public IP address's version. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.ipAddress | String | The public IP address's IP address. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.publicIPAllocationMethod | String | The public IP address's allocation method. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.resourceGuid | String | The public IP address's resource GUID. |
| Azure.VirtualNetworks.PublicIPAddresses.sku.name | String | The public IP address's SKU name. |
| Azure.VirtualNetworks.PublicIPAddresses.sku.tier | String | The public IP address's SKU tier. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.ipConfiguration | String | The reference to another IP configuration associated with this resource. |
azure-vn-security-groups-list#
List all network security groups. Required permissions: Microsoft.Network/networkSecurityGroups/read.
Base Command#
azure-vn-security-groups-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.SecurityGroups.name | String | The security group's name. |
| Azure.VirtualNetworks.SecurityGroups.id | String | The security group's ID. |
| Azure.VirtualNetworks.SecurityGroups.type | String | The security group's type. |
| Azure.VirtualNetworks.SecurityGroups.location | String | The security group's location. |
| Azure.VirtualNetworks.SecurityGroups.etag | String | The security group's ETag. |
| Azure.VirtualNetworks.SecurityGroups.tags | String | The security group's tags. |
| Azure.VirtualNetworks.SecurityGroups.properties.defaultSecurityRules | List | The default security rules. |
| Azure.VirtualNetworks.SecurityGroups.properties.networkInterfaces | List | The network interfaces. |
| Azure.VirtualNetworks.SecurityGroups.properties.provisioningState | String | The provisioning state. |
| Azure.VirtualNetworks.SecurityGroups.properties.resourceGuid | String | The resource GUID. |
| Azure.VirtualNetworks.SecurityGroups.properties.SecurityRules | List | The security rules. |
azure-vn-security-rule-create#
Create a security rule. Required permissions: Microsoft.Network/networkSecurityGroups/securityRules/read, Microsoft.Network/networkSecurityGroups/securityRules/write.
Base Command#
azure-vn-security-rule-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | Resource group name. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to create. | Required |
| direction | The direction of the rule. Possible values are: Inbound, Outbound. | Required |
| access | Whether to allow the traffic. Possible values are: Allow, Deny. Default is Allow. | Optional |
| protocol | The protocol on which to apply the rule. Possible values are: Any, TCP, UDP, ICMP. Default is Any. | Optional |
| source | The source IP address range from which incoming traffic is allowed or denied by this rule. Possible values are "Any", an IP address range, an application security group, or a default tag. Default is Any. | Optional |
| priority | The priority of the rule, with a value between 100 and 4096. Each rule in the collection must have a unique priority number. Lower numbers indicate higher priority. | Required |
| source_ports | The source ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk () to allow traffic on any port. Default is ``. | Optional |
| destination | The destination IP address range for outgoing traffic that is allowed or denied by this rule. The destination filter can be "Any", an IP address range, an application security group, or a default tag. Default is Any. | Optional |
| destination_ports | The destination ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk () to allow traffic on any port. Default is. | Optional |
| description | A description to add to the rule. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.SecurityRules.name | String | The rule's name. |
| Azure.VirtualNetworks.SecurityRules.id | String | The rule's ID. |
| Azure.VirtualNetworks.SecurityRules.etag | String | The rule's ETag. |
| Azure.VirtualNetworks.SecurityRules.type | String | The rule's type. |
| Azure.VirtualNetworks.SecurityRules.properties.provisioningState | String | The rule's provisioning state. |
| Azure.VirtualNetworks.SecurityRules.properties.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRange | String | For a single port, the source port or a range of ports. For multiple ports, sourcePortRanges is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRanges | String | For multiple ports, a list of ports. For a single port, sourcePortRange is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRange | String | For a single port, the destination port or range of ports. For multiple ports, destinationPortRanges is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRanges | String | For multiple ports, a list of destination ports. For a single port, destinationPortRange is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.sourceAddressPrefix | String | The source address. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationAddressPrefix | String | The destination address. |
| Azure.VirtualNetworks.SecurityRules.properties.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.VirtualNetworks.SecurityRules.properties.priority | Number | The rule’s priority, ranging from 100 to 4096. |
| Azure.VirtualNetworks.SecurityRules.properties.direction | String | The rule's direction, which can be "Inbound" or "Outbound". |
azure-vn-network-interface-create#
Creates a virtual machine network interface. Required permissions: Microsoft.Network/networkInterfaces/write, Microsoft.Network/virtualNetworks/subnets/join/action, Microsoft.Network/networkSecurityGroups/join/action.
Base Command#
azure-vn-network-interface-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group to which the new network interface will belong. | Required |
| nic_name | The network interface name. | Required |
| nic_location | The location in which to create the network interface. Possible values are: westus2, westus, westindia, westeurope, westcentralus, uksouth, ukwest, southeastasia, northcentralus, northeurope, southcentralus, southindia, francesouth, francecentral, japaneast, japanwest, koreacentral, koreasouth, brazilsouth, canadacentral, canadaeast, centralindia, eastus2, eastasia, centralus, eastus, australiacentral, australiacentral2, australiaeast, australiasoutheast. | Required |
| vnet_name | The name of the virtual network of the network interface. | Required |
| subnet_name | The name of the subnet of the network interface. | Required |
| address_assignment_method | The address assignment method. Possible values are: Static, Dynamic. Default is Dynamic. | Optional |
| private_ip_address | The private IP address of the network interface. Required if the address_assignment_method argument is set to Static. | Optional |
| ip_config_name | The name of the IP address configuration. | Required |
| network_security_group | The network security group of the network interface. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.NetworkInterfaces.id | String | The ID of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.name | String | The name of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.etag | String | The unique read-only string that changes whenever the network interface is updated. |
| Azure.VirtualNetworks.NetworkInterfaces.location | String | The location of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.tags | Unknown | The tags of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.provisioningState | String | The provisioning state, which only appears in the response. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.ipConfigurations | Unknown | The IP configurations of the network interface, containing the name, id, and properties fields. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.networkSecurityGroup | Unknown | The network security group attached to the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.dnsSettings | Unknown | The DNS settings of the network interface. |
azure-vn-network-interface-update#
Updates a network interface. Required Permissions: Microsoft.Network/networkInterfaces/read, Microsoft.Network/networkInterfaces/write, Microsoft.Network/virtualNetworks/subnets/join/action, Microsoft.Network/publicIPAddresses/join/action, Microsoft.Network/networkSecurityGroups/join/action, Microsoft.Network/loadBalancers/backendAddressPools/join/action.
Base Command#
azure-vn-network-interface-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group to which the network interface belongs. | Required |
| network_interface_name | The name of the network interface to update. | Required |
| location | The location of the network security group. Possible values are: australiacentral, australiacentral2, australiaeast, australiasoutheast, brazilsouth, brazilsoutheast, brazilus, canadacentral, canadaeast, centralindia, centralus, centraluseuap, eastasia, eastus, eastus2, eastus2euap, francecentral, francesouth, germanynorth, germanywestcentral, israelcentral, italynorth, japaneast, japanwest, jioindiacentral, jioindiawest, koreacentral, koreasouth, malaysiasouth, mexicocentral, newzealandnorth, northcentralus, northeurope, norwayeast, norwaywest, polandcentral, qatarcentral, southafricanorth, southafricawest, southcentralus, southeastasia, southindia, spaincentral, swedencentral, swedensouth, switzerlandnorth, switzerlandwest, uaecentral, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2, westus3, australiaeastfoundational, austriaeast, chilecentral, eastusslv, indonesiacentral, israelnorthwest, malaysiawest, southcentralus2, southeastus, southeastus3, southwestus, usgovarizona, usgovtexas, usgovvirginia. | Optional |
| enable_ip_forwarding | Whether to enable IP forwarding for the network interface. Possible values are: true, false. | Optional |
| enable_accelerate_networking | Whether the network interface is configured for accelerated networking. Possible values are: true, false. | Optional |
| auxiliary_mode | The auxiliary mode of the Network Interface resource. Possible values are: MaxConnections, Floating, AcceleratedConnections. | Optional |
| auxiliary_sku | The auxiliary SKU of the Network Interface resource. Possible values are: A1, A2, A4, A8. | Optional |
| dns_servers | A comma-separated list of DNS server IP addresses for the network interface. | Optional |
| internal_dns_name_label | The internal DNS name label for the network interface. | Optional |
| network_security_group_name | The name of the network security group. | Optional |
| remove_network_security_group | Whether to remove the property networkSecurityGroup from the network interface. Possible values are: yes, no. Default is no. | Optional |
| nic_type | The type of Network Interface resource. Possible values are: Standard, Elastic. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.NetworkInterfaces.id | String | The network interface ID. |
| Azure.VirtualNetworks.NetworkInterfaces.name | String | The network interface name. |
| Azure.VirtualNetworks.NetworkInterfaces.location | String | The Azure region where the network interface is deployed. |
| Azure.VirtualNetworks.NetworkInterfaces.etag | String | A unique read-only string that changes whenever the network interface resource is updated. |
| Azure.VirtualNetworks.NetworkInterfaces.type | String | The resource type. |
| Azure.VirtualNetworks.NetworkInterfaces.tags | Unknown | The resource tags. |
| Azure.VirtualNetworks.NetworkInterfaces.extendedLocation | Unknown | The extended location of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.provisioningState | String | The current provisioning state of the network interface (e.g., Succeeded, Updating, Failed). |
| Azure.VirtualNetworks.NetworkInterfaces.properties.ipConfigurations | Unknown | The list of IP configurations for the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.dnsSettings | Unknown | The DNS configuration of the network interface, including DNS servers and domain name. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.macAddress | String | The MAC address of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.enableIPForwarding | Boolean | Whether IP forwarding is enabled for the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.enableAcceleratedNetworking | Boolean | Whether accelerated networking is enabled for the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.networkSecurityGroup | Unknown | The network security group associated with the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.primary | Boolean | Whether this is a primary network interface on a virtual machine. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.virtualMachine | Unknown | The reference to a virtual machine. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.nicType | String | The type of network interface (Standard or Elastic). |
| Azure.VirtualNetworks.NetworkInterfaces.properties.auxiliaryMode | Unknown | The auxiliary mode of the Network Interface resource. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.auxiliarySku | Unknown | The auxiliary SKU of the Network Interface resource. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.defaultOutboundConnectivityEnabled | Boolean | Whether default outbound connectivity for nic was configured. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.disableTcpStateTracking | Boolean | Whether to disable TCP state tracking. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.dscpConfiguration | Unknown | A reference to the DSCP configuration to which the network interface is linked. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.hostedWorkloads | Unknown | A list of references to linked BareMetal resources. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.migrationPhase | Unknown | The migration phase of the Network Interface resource. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.privateEndpoint | Unknown | A reference to the private endpoint to which the network interface is linked. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.privateLinkService | Unknown | The privatelinkservice of the network interface resource. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.resourceGuid | String | The resource GUID property of the network interface resource. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.tapConfigurations | Unknown | A list of TapConfigurations of the network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.vnetEncryptionSupported | Boolean | Whether the virtual machine this nic is attached to supports encryption. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.workloadType | String | The workload type of the NetworkInterface for BareMetal resources. |
azure-vn-security-rule-delete#
Delete a security rule. Required permissions: Microsoft.Network/networkSecurityGroups/securityRules/delete.
Base Command#
azure-vn-security-rule-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | Resource group name. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to delete. | Required |
Context Output#
There is no context output for this command.
azure-vn-security-rule-get#
Get a specific rule. Required permissions: Microsoft.Network/networkSecurityGroups/securityRules/read.
Base Command#
azure-vn-security-rule-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | Resource group name. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to get. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.SecurityRules.name | String | The rule's name. |
| Azure.VirtualNetworks.SecurityRules.id | String | The rule's ID. |
| Azure.VirtualNetworks.SecurityRules.location | String | The rule's location. |
| Azure.VirtualNetworks.SecurityRules.etag | String | The rule's ETag. |
| Azure.VirtualNetworks.SecurityRules.type | String | The rule's type. |
| Azure.VirtualNetworks.SecurityRules.properties.provisioningState | String | The rule's provisioning state. |
| Azure.VirtualNetworks.SecurityRules.properties.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRange | String | For a single port, the source port or a range of ports. For multiple ports, sourcePortRanges is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRanges | String | For multiple ports, a list of ports. For a single port, sourcePortRange is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRange | String | For a single port, the destination port or range of ports. For multiple ports, destinationPortRanges is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRanges | String | For multiple ports, a list of destination ports. For a single port, destinationPortRange is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.sourceAddressPrefix | String | The source address. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationAddressPrefix | String | The destination address. |
| Azure.VirtualNetworks.SecurityRules.properties.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.VirtualNetworks.SecurityRules.properties.priority | Number | The rule’s priority, ranging from 100 to 4096. |
| Azure.VirtualNetworks.SecurityRules.properties.direction | String | The rule's direction, which can be "Inbound" or "Outbound". |
azure-vn-security-rule-update#
Update a security rule. If one does not exist, it will be created. Required permissions: Microsoft.Network/networkSecurityGroups/securityRules/read, Microsoft.Network/networkSecurityGroups/securityRules/write.
Base Command#
azure-vn-security-rule-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| security_group_name | The name of the security group. | Required |
| security_rule_name | The name of the rule to be updated. | Required |
| direction | The direction of the rule. Possible values are: Inbound, Outbound. | Optional |
| protocol | The protocol on which to apply the rule. Possible values are: Any, TCP, UDP, ICMP. | Optional |
| source | The source IP address range from which incoming traffic will be allowed or denied by this rule. Possible values are "Any", an IP address range, an application security group, or a default tag. | Optional |
| priority | The priority by which the rules will be processed. The lower the number, the higher the priority. We recommend leaving gaps between rules - 100, 200, 300, etc. - so that it is easier to add new rules without having to edit existing rules. | Optional |
| source_ports | The source ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk (*) to allow traffic on any port. | Optional |
| destination | The destination IP address range for outgoing traffic that is allowed or denied by this rule. The destination filter can be "Any", an IP address range, an application security group, or a default tag. | Optional |
| destination_ports | The destination ports from which traffic is allowed or denied by this rule. Provide a single port, such as 80; a port range, such as 1024-65535; or a comma-separated list of single ports and/or port ranges, such as 80,1024-65535. Use an asterisk (*) to allow traffic on any port. | Optional |
| description | A description to add to the rule. | Optional |
| access | The network traffic is allowed or denied. Possible values are: Allow, Deny. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.SecurityRules.name | String | The rule's name. |
| Azure.VirtualNetworks.SecurityRules.id | String | The rule's ID. |
| Azure.VirtualNetworks.SecurityRules.etag | String | The rule's ETag. |
| Azure.VirtualNetworks.SecurityRules.type | String | The rule's type. |
| Azure.VirtualNetworks.SecurityRules.properties.provisioningState | String | The rule's provisioning state. |
| Azure.VirtualNetworks.SecurityRules.properties.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRange | String | For a single port, the source port or a range of ports. For multiple ports, sourcePortRanges is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRanges | String | For multiple ports, a list of ports. For a single port, sourcePortRange is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRange | String | For a single port, the destination port or range of ports. For multiple ports, destinationPortRanges is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRanges | String | For multiple ports, a list of destination ports. For a single port, destinationPortRange is used instead. |
| Azure.VirtualNetworks.SecurityRules.properties.sourceAddressPrefix | String | The source address. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationAddressPrefix | String | The destination address. |
| Azure.VirtualNetworks.SecurityRules.properties.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.VirtualNetworks.SecurityRules.properties.priority | Number | The rule’s priority, ranging from 100 to 4096. |
| Azure.VirtualNetworks.SecurityRules.properties.direction | String | The rule's direction, which can be "Inbound" or "Outbound". |
azure-vn-security-rules-list#
Gets all security rules in a network security group. Required permissions: Microsoft.Network/networkSecurityGroups/securityRules/read.
Base Command#
azure-vn-security-rules-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | Resource group name. | Required |
| network_security_group_name | The name of the network security group. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.SecurityRules.name | String | The rule's name. |
| Azure.VirtualNetworks.SecurityRules.id | String | The rule's ID. |
| Azure.VirtualNetworks.SecurityRules.properties.provisioningState | String | The rule's provisioning state. |
| Azure.VirtualNetworks.SecurityRules.properties.protocol | String | The protocol, which can be "TCP", "UDP", "ICMP", or "*". |
| Azure.VirtualNetworks.SecurityRules.properties.sourcePortRange | String | For a single port, the source port or a range of ports. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationPortRange | String | For a single port, the destination port or range of ports. |
| Azure.VirtualNetworks.SecurityRules.properties.sourceAddressPrefix | String | The source address. |
| Azure.VirtualNetworks.SecurityRules.properties.destinationAddressPrefix | String | The destination address. |
| Azure.VirtualNetworks.SecurityRules.properties.access | String | The rule's access. Can be "Allow" or "Deny". |
| Azure.VirtualNetworks.SecurityRules.properties.priority | Number | The rule’s priority, ranging from 100 to 4096. |
| Azure.VirtualNetworks.SecurityRules.properties.direction | String | The rule's direction, which can be "Inbound" or "Outbound". |
Base Command#
azure-vn-network-interface-get#
Gets the properties of a given network interface. Required permissions: Microsoft.Network/networkInterfaces/read.
Base Command#
azure-vn-network-interface-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group to which the network interface belongs. | Required |
| network_interface_name | The name of the network interface you want to view the details of. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.NetworkInterfaces.properties.ipConfigurations | Unknown | The interface public IP address ID. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.macAddress | String | The interface MAC address. |
| Azure.VirtualNetworks.NetworkInterfaces.name | String | The interface name. |
| Azure.VirtualNetworks.NetworkInterfaces.location | String | The interface location. |
| Azure.VirtualNetworks.NetworkInterfaces.id | String | The interface ID. |
| Azure.VirtualNetworks.NetworkInterfaces.etag | String | A unique read-only string that changes whenever the network interface resource is updated. |
| Azure.VirtualNetworks.NetworkInterfaces.kind | String | The type of the network interface resource, used for Azure internal classification. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.tapConfigurations | String | The list of tap configurations attached to the network interface for traffic mirroring. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.allowPort25Out | String | Indicates whether outbound traffic on port 25 (SMTP) is allowed from this network interface. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.nicType | String | Specifies the type of network interface, such as Standard or Elastic. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.provisioningState | String | The current provisioning state of the network interface (e.g., Succeeded, Updating, Failed). |
| Azure.VirtualNetworks.NetworkInterfaces.properties.dnsSettings | String | The DNS configuration of the network interface, including DNS servers and domain name. |
| Azure.VirtualNetworks.NetworkInterfaces.properties.enableIPForwarding | String | Indicates whether IP forwarding is enabled for the network interface. |
azure-vn-public-ip-address-get#
Gets the properties of a given public IP address. Permissions required: Microsoft.Network/publicIPAddresses/read.
Base Command#
azure-vn-public-ip-address-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group to which the IP address belongs. | Required |
| address_name | The IP address name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.PublicIPAddresses.name | String | The public IP address's name. |
| Azure.VirtualNetworks.PublicIPAddresses.id | String | The public IP address's ID. |
| Azure.VirtualNetworks.PublicIPAddresses.location | String | The location of the public IP address. |
| Azure.VirtualNetworks.PublicIPAddresses.sku | String | The public IP address's SKU. |
| Azure.VirtualNetworks.PublicIPAddresses.type | String | The type of the public IP address. |
| Azure.VirtualNetworks.PublicIPAddresses.etag | String | The public IP address's ETag. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.provisioningState | String | The public IP address's provisioning state. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.publicIPAddressVersion | String | The public IP address's version. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.ipAddress | String | The public IP address's IP address. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.publicIPAllocationMethod | String | The public IP address's allocation method. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.resourceGuid | String | The public IP address's resource GUID. |
| Azure.VirtualNetworks.PublicIPAddresses.sku.name | String | The public IP address's SKU name. |
| Azure.VirtualNetworks.PublicIPAddresses.sku.tier | String | The public IP address's SKU tier. |
| Azure.VirtualNetworks.PublicIPAddresses.properties.ipConfiguration | String | The reference to another IP configuration associated with this resource. |
azure-storage-blob-container-update#
Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist. Required permissions: Microsoft.Storage/storageAccounts/blobServices/containers/write.
Base Command#
azure-storage-blob-container-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| container_name | The container name. | Required |
| default_encryption_scope | Uses the specified encryption scope by default for all writes to the container. | Optional |
| deny_encryption_scope_override | Blocks overriding the container’s default encryption scope. Possible values are: true, false. | Optional |
| public_access | Specifies the access level. Possible values are: Blob, Container, None. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.BlobContainers.id | String | Fully qualified resource ID for the resource. |
| Azure.Storage.BlobContainers.name | String | The name of the resource. |
| Azure.Storage.BlobContainers.type | String | The resource type. |
| Azure.Storage.BlobContainers.properties.metadata | String | A name-value pair to associate with the container as metadata. |
| Azure.Storage.BlobContainers.properties.publicAccess | String | Specifies whether data in the container may be accessed publicly and the access level. |
| Azure.Storage.BlobContainers.properties.hasImmutabilityPolicy | Boolean | The hasImmutabilityPolicy property is set to true by SRP if an ImmutabilityPolicy exists for this container, and false if it does not. |
| Azure.Storage.BlobContainers.properties.hasLegalHold | Boolean | The hasLegalHold property is set to true by SRP if at least one legal hold tag exists, and false if all tags are cleared. |
azure-storage-blob-create#
Create a new Blob under the specified Container. Required permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write.
Base Command#
azure-storage-blob-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| container_name | The name of the Blob Container. | Required |
| file_entry_id | The entry ID of the file to upload as a new blob. Available from the war room while the context data contains file output. | Required |
| blob_name | The name of the Blob to create. Default is the file name. | Optional |
Context Output#
There is no context output for this command.
azure-storage-blob-get#
Retrieve a Blob from a Container. Required permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read.
Base Command#
azure-storage-blob-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the Blob to retrieve. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| File.Size | String | The size of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| File.Name | String | The name of the file. |
| File.SSDeep | String | The SSDeep hash of the file. |
| File.EntryID | String | The entry ID of the file. |
| File.Info | String | File information. |
| File.Type | String | The file type. |
| File.MD5 | String | The MD5 hash of the file. |
| File.Extension | String | The file extension. |
azure-storage-blob-tag-set#
Updates the tags for the specified Blob. The command can replace the entire tags of the Blob and can be used to remove tags. Required permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/write.
Base Command#
azure-storage-blob-tag-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| tags | Tags fields in JSON format: {"tag-name-1": "tag-value-1", "tag-name-2": "tag-value-2"}. The tags fields may contain at most 10 tags. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| append | Whether to append tags to the existing tags or not. Default is false. Possible values are: true, false. | Optional |
Context Output#
There is no context output for this command.
azure-storage-blob-property-set#
Set Blob properties. Required permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write.
Base Command#
azure-storage-blob-property-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the Blob Container. | Required |
| blob_name | The name of the blob. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
| content_type | Blob content type. Indicates the media type of the blob. | Optional |
| content_md5 | Blob MD5 hash value. Can be used by the client to check for content integrity. | Optional |
| content_encoding | Blob content encoding. Used to specify the compression algorithm of the blob content. Possible values are: identity, gzip, deflate, br, compress, zstd, aes128gcm, dcb, dcz, exi, pack200-gzip, x-compress, x-gzip. | Optional |
| content_language | Blob content language. Describes the human languages of the blob content. | Optional |
| content_disposition | Blob content disposition. Conveys additional information about how to process the response payload, and also can be used to attach additional metadata. | Optional |
| cache_control | Modifies the cache control string for the blob. Indicates directives for caching in both requests and responses. | Optional |
| request_id | Request ID generated by the client and recorded in the analytics logs when storage analytics logging is enabled. | Optional |
| lease_id | Required if the blob has an active lease. | Optional |
Context Output#
There is no context output for this command.
azure-appservice-webapp-config-update#
Updates the configuration settings of an existing Azure Web App. Required permissions: Microsoft.Web/sites/config/write, Microsoft.Web/sites/config/read.
Base Command#
azure-appservice-webapp-config-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| name | Name of the Web App. | Required |
| http20_enabled | Configures a web site to allow clients to connect over http2.0. Possible values are: true, false. | Optional |
| remote_debugging_enabled | True if remote debugging is enabled; otherwise, false. Possible values are: true, false. | Optional |
| min_tls_version | Configures the minimum version of TLS required for SSL requests. Possible values are: 1.0, 1.1, 1.2, 1.3. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.AppService.WebAppConfiguration.id | String | Resource ID. |
| Azure.AppService.WebAppConfiguration.name | String | Resource name. |
| Azure.AppService.WebAppConfiguration.type | String | Resource type. |
| Azure.AppService.WebAppConfiguration.location | String | Resource location. |
| Azure.AppService.WebAppConfiguration.properties.numberOfWorkers | Number | Number of workers. |
| Azure.AppService.WebAppConfiguration.properties.defaultDocuments | Unknown | List of default documents. |
| Azure.AppService.WebAppConfiguration.properties.netFrameworkVersion | String | .NET Framework version. |
| Azure.AppService.WebAppConfiguration.properties.phpVersion | String | PHP version. |
| Azure.AppService.WebAppConfiguration.properties.pythonVersion | String | Python version. |
| Azure.AppService.WebAppConfiguration.properties.nodeVersion | String | Node.js version. |
| Azure.AppService.WebAppConfiguration.properties.powerShellVersion | String | PowerShell version. |
| Azure.AppService.WebAppConfiguration.properties.linuxFxVersion | String | Linux app framework and version. |
| Azure.AppService.WebAppConfiguration.properties.windowsFxVersion | String | Windows container image name. |
| Azure.AppService.WebAppConfiguration.properties.requestTracingEnabled | Boolean | Indicates whether request tracing is enabled. |
| Azure.AppService.WebAppConfiguration.properties.remoteDebuggingEnabled | Boolean | Indicates whether remote debugging is enabled. |
| Azure.AppService.WebAppConfiguration.properties.remoteDebuggingVersion | String | Remote debugging version. |
| Azure.AppService.WebAppConfiguration.properties.http20Enabled | Boolean | Indicates whether HTTP/2 is enabled. |
| Azure.AppService.WebAppConfiguration.properties.minTlsVersion | String | Minimum TLS version required. |
| Azure.AppService.WebAppConfiguration.properties.ftpsState | String | State of FTP / FTPS service. |
| Azure.AppService.WebAppConfiguration.properties.webSocketsEnabled | Boolean | Indicates whether WebSockets are enabled. |
| Azure.AppService.WebAppConfiguration.properties.alwaysOn | Boolean | Indicates whether Always On is enabled. |
| Azure.AppService.WebAppConfiguration.properties.managedPipelineMode | String | Managed pipeline mode. |
| Azure.AppService.WebAppConfiguration.properties.loadBalancing | String | Site load balancing mode. |
| Azure.AppService.WebAppConfiguration.properties.autoHealEnabled | Boolean | Indicates whether Auto Heal is enabled. |
| Azure.AppService.WebAppConfiguration.properties.autoHealRules | Unknown | Auto Heal rules configuration. |
| Azure.AppService.WebAppConfiguration.properties.cors | Unknown | Cross-Origin Resource Sharing (CORS) settings. |
| Azure.AppService.WebAppConfiguration.properties.apiDefinition.url | String | URL of the API definition. |
| Azure.AppService.WebAppConfiguration.properties.apiManagementConfig.id | String | Azure API management integration ID. |
azure-appservice-webapp-auth-settings-update#
Updates the authentication and authorization settings of an existing Azure Web App. Required permissions: Microsoft.Web/sites/config/read, Microsoft.Web/sites/config/write.
Base Command#
azure-appservice-webapp-auth-settings-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| name | Name of the Web App. | Required |
| enabled | True if the Authentication / Authorization feature is enabled for the current app; otherwise, false. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.AppService.WebAppAuthSettings.id | String | Resource ID. |
| Azure.AppService.WebAppAuthSettings.name | String | Resource Name. |
| Azure.AppService.WebAppAuthSettings.type | String | Resource type. |
| Azure.AppService.WebAppAuthSettings.properties.enabled | Boolean | Indicates whether Authentication/Authorization is enabled for the app. |
| Azure.AppService.WebAppAuthSettings.properties.runtimeVersion | String | The RuntimeVersion of the Authentication/Authorization feature. |
| Azure.AppService.WebAppAuthSettings.properties.unauthenticatedClientAction | String | The action to take when an unauthenticated client attempts to access the app. |
| Azure.AppService.WebAppAuthSettings.properties.tokenStoreEnabled | Boolean | Indicates whether the Azure App Service Authentication platform’s token store is enabled. |
| Azure.AppService.WebAppAuthSettings.properties.allowedExternalRedirectUrls | Unknown | External URLs that are allowed to be redirected to as part of logging in or logging out of the app. |
| Azure.AppService.WebAppAuthSettings.properties.defaultProvider | String | The default authentication provider to use when multiple providers are configured. |
| Azure.AppService.WebAppAuthSettings.properties.clientId | String | The Client ID of the app used for AAD login. |
| Azure.AppService.WebAppAuthSettings.properties.clientSecret | String | The client secret associated with the AAD app. |
| Azure.AppService.WebAppAuthSettings.properties.clientSecretSettingName | String | The app setting that contains the client secret. |
| Azure.AppService.WebAppAuthSettings.properties.issuer | String | The OpenID Connect Issuer URI that represents the entity that issues access tokens. |
| Azure.AppService.WebAppAuthSettings.properties.allowedAudiences | Unknown | The list of audiences that can receive the authentication tokens. |
| Azure.AppService.WebAppAuthSettings.properties.additionalLoginParams | Unknown | Additional parameters to send to the authentication provider. |
| Azure.AppService.WebAppAuthSettings.properties.isAadAutoProvisioned | Boolean | True if AAD is auto-provisioned; otherwise false. |
| Azure.AppService.WebAppAuthSettings.properties.googleClientId | String | The Client ID of the app used for Google login. |
| Azure.AppService.WebAppAuthSettings.properties.googleClientSecret | String | The client secret associated with the Google app. |
| Azure.AppService.WebAppAuthSettings.properties.googleClientSecretSettingName | String | The app setting that contains the client secret. |
| Azure.AppService.WebAppAuthSettings.properties.facebookAppId | String | The App ID of the Facebook app used for login. |
| Azure.AppService.WebAppAuthSettings.properties.facebookAppSecret | String | The app secret associated with the Facebook app. |
| Azure.AppService.WebAppAuthSettings.properties.facebookAppSecretSettingName | String | The app setting that contains the Facebook app secret. |
| Azure.AppService.WebAppAuthSettings.properties.twitterConsumerKey | String | The OAuth 1.0a consumer key of the Twitter application used for login. |
| Azure.AppService.WebAppAuthSettings.properties.twitterConsumerSecret | String | The consumer secret associated with the Twitter application. |
| Azure.AppService.WebAppAuthSettings.properties.twitterConsumerSecretSettingName | String | The app setting that contains the Twitter consumer secret. |
| Azure.AppService.WebAppAuthSettings.properties.microsoftAccountClientId | String | The OAuth 2.0 client ID for the Microsoft account provider. |
| Azure.AppService.WebAppAuthSettings.properties.microsoftAccountClientSecret | String | The client secret for the Microsoft account provider. |
| Azure.AppService.WebAppAuthSettings.properties.microsoftAccountClientSecretSettingName | String | The app setting that contains the Microsoft account client secret. |
| Azure.AppService.WebAppAuthSettings.properties.appleClientId | String | The client ID for the Apple provider. |
| Azure.AppService.WebAppAuthSettings.properties.appleClientSecret | String | The client secret for the Apple provider. |
| Azure.AppService.WebAppAuthSettings.properties.appleClientSecretSettingName | String | The app setting that contains the Apple provider client secret. |
| Azure.AppService.WebAppAuthSettings.properties.authFilePath | String | The path to the authentication configuration file. |
azure-compute-disk-update#
Updates a disk. Required permissions: Microsoft.Compute/disks/read, Microsoft.Compute/disks/write.
Base Command#
azure-compute-disk-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| disk_name | The name of the managed disk that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. | Required |
| public_network_access | Policy for controlling export on the disk. Possible values are: Disabled, Enabled. | Optional |
| network_access_policy | Policy for accessing the disk via network. Possible values are: AllowAll, AllowPrivate, DenyAll. | Optional |
| data_access_auth_mode | Additional authentication requirements when exporting or uploading to a disk or snapshot. Possible values are: AzureActiveDirectory. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Compute.Disks.id | String | Resource ID of the disk. |
| Azure.Compute.Disks.name | String | Name of the disk. |
| Azure.Compute.Disks.type | String | Type of the resource. |
| Azure.Compute.Disks.location | String | Location of the disk. |
| Azure.Compute.Disks.tags | Unknown | Resource tags. |
| Azure.Compute.Disks.managedBy | String | ARM ID of the resource that manages the disk. |
| Azure.Compute.Disks.sku | unknown | The disk SKU name. |
| Azure.Compute.Disks.zones | unknown | A list of availability zones. |
| Azure.Compute.Disks.properties.timeCreated | String | The time when the disk was created. |
| Azure.Compute.Disks.properties.diskSizeGB | Number | Size of the disk in GB. |
| Azure.Compute.Disks.properties.diskIopsReadWrite | Number | The number of IOPS allowed for this disk. |
| Azure.Compute.Disks.properties.diskMBpsReadWrite | Number | The bandwidth allowed for this disk in MBps. |
| Azure.Compute.Disks.properties.diskIOPSReadOnly | Number | The number of read-only IOPS for this disk. |
| Azure.Compute.Disks.properties.diskMBpsReadOnly | Number | The read-only bandwidth for this disk in MBps. |
| Azure.Compute.Disks.properties.diskSizeBytes | Number | The size of the disk in bytes. |
| Azure.Compute.Disks.properties.networkAccessPolicy | String | Policy for accessing the disk via network. |
| Azure.Compute.Disks.properties.publicNetworkAccess | String | Policy for export on the disk. |
| Azure.Compute.Disks.properties.burstingEnabled | Boolean | Whether bursting is enabled on the disk. |
| Azure.Compute.Disks.properties.optimization | String | The disk optimization setting. |
| Azure.Compute.Disks.properties.diskState | String | The current state of the disk. |
| Azure.Compute.Disks.properties.supportedCapabilities | unknown | Supported capabilities of the disk. |
| Azure.Compute.Disks.properties.supportedPerformanceTiers | unknown | Supported performance tiers of the disk. |
| Azure.Compute.Disks.properties.supportedDiskTypes | unknown | Supported disk types for the disk. |
| Azure.Compute.Disks.properties.provisioningState | unknown | The provisioning state of the disk. |
| Azure.Compute.Disks.properties.timeModified | unknown | The time when the disk was last modified. |
| Azure.Compute.Disks.properties.diskAccessId | String | The ARM ID of the DiskAccess resource. |
| Azure.Compute.Disks.properties.networkProfile | unknown | The network profile of the disk. |
| Azure.Compute.Disks.properties.creationData | unknown | Disk creation data. |
| Azure.Compute.Disks.properties.encryption | unknown | Encryption settings for the disk. |
| Azure.Compute.Disks.properties.encryptionSettingsCollection | unknown | A collection of encryption settings. |
| Azure.Compute.Disks.properties.encryptionType | String | The type of key used to encrypt the data on the disk. |
| Azure.Compute.Disks.properties.securityProfile | unknown | Security profile for the disk. |
| Azure.Compute.Disks.properties.tieringProfile | unknown | Tiering profile for the disk. |
| Azure.Compute.Disks.properties.supportedTierList | unknown | List of supported tiers for the disk. |
| Azure.Compute.Disks.properties.availabilityZone | String | Availability zone of the disk. |
| Azure.Compute.Disks.properties.dataAccessAuthMode | String | Additional authentication requirements when exporting or uploading to a disk. |
| Azure.Compute.Disks.properties.osType | String | The operating system type. |
| Azure.Compute.Disks.properties.hyperVGeneration | String | The HyperVGenerationType of the virtual machine. |
| Azure.Compute.Disks.properties.lastOwnershipUpdateTime | String | The last time ownership of the disk was updated. |
azure-appservice-webapp-update#
Updates an Azure Web App. The required permissions are: Microsoft.Web/sites/read, Microsoft.Web/sites/write.
Base Command#
azure-appservice-webapp-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| name | Name of the Web App. | Required |
| identity_type | Managed service identity type. Possible values are: None, SystemAssigned. | Optional |
| https_only | Configures the web site to accept only https requests. Possible values are: true, false. | Optional |
| client_cert_enabled | Whether client certificates are enabled. Possible values are: true, false. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.AppService.WebApp.id | String | Fully qualified resource ID for the web app. |
| Azure.AppService.WebApp.name | String | The name of the web app. |
| Azure.AppService.WebApp.type | String | The resource type, e.g., Microsoft.Web/sites. |
| Azure.AppService.WebApp.location | String | Geographic location of the web app. |
| Azure.AppService.WebApp.kind | String | The kind of the app, e.g., app, functionapp, etc. |
| Azure.AppService.WebApp.tags | Unknown | Resource tags as key-value pairs. |
| Azure.AppService.WebApp.identity.type | String | The type of managed identity (SystemAssigned, UserAssigned, etc.). |
| Azure.AppService.WebApp.identity.principalId | String | The principal ID of the system-assigned identity. |
| Azure.AppService.WebApp.identity.tenantId | String | The tenant ID of the system-assigned identity. |
| Azure.AppService.WebApp.identity.userAssignedIdentities | Unknown | The list of user-assigned identities associated with the web app. |
| Azure.AppService.WebApp.properties.state | String | Current state of the web app (Running, Stopped, etc.). |
| Azure.AppService.WebApp.properties.enabled | Boolean | Whether the web app is enabled. |
| Azure.AppService.WebApp.properties.defaultHostName | String | Default host name of the web app. |
| Azure.AppService.WebApp.properties.hostNames | String | List of host names associated with the web app. |
| Azure.AppService.WebApp.properties.repositorySiteName | String | Name of the repository site. |
| Azure.AppService.WebApp.properties.clientAffinityEnabled | Boolean | Whether client affinity is enabled. |
| Azure.AppService.WebApp.properties.clientCertEnabled | Boolean | Whether client certificates are enabled. |
| Azure.AppService.WebApp.properties.clientCertExclusionPaths | String | Paths to exclude from client certificate authentication. |
| Azure.AppService.WebApp.properties.hostingEnvironment | String | App Service Environment to use for the web app. |
| Azure.AppService.WebApp.properties.serverFarmId | String | Resource ID of the associated App Service plan. |
| Azure.AppService.WebApp.properties.reserved | Boolean | Whether the web app is on a Linux plan. |
| Azure.AppService.WebApp.properties.isXenon | Boolean | Whether the web app is hosted in Xenon. |
| Azure.AppService.WebApp.properties.hyperV | Boolean | Whether Hyper-V is enabled for the web app. |
| Azure.AppService.WebApp.properties.siteConfig | Unknown | Configuration of the app. |
azure-cr-registry-update#
Updates a container registry. Required permissions: Microsoft.ContainerRegistry/registries/read, Microsoft.ContainerRegistry/registries/write.
Base Command#
azure-cr-registry-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| registry_name | The name of the container registry. | Required |
| allow_exports | Whether artifacts can be exported. Possible values are: disabled, enabled. | Optional |
| public_network_access | Whether public network access is allowed for the container registry. Possible values are: disabled, enabled. | Optional |
| anonymous_pull_enabled | Whether to enable registry-wide pulls from unauthenticated clients. Possible values are: true, false. | Optional |
| authentication_as_arm_policy | Whether the policy is enabled or not. Possible values are: disabled, enabled. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ContainerRegistry.Registries.id | String | The resource ID. |
| Azure.ContainerRegistry.Registries.identity | Unknown | The identity of the container registry. |
| Azure.ContainerRegistry.Registries.location | String | The location of the resource. |
| Azure.ContainerRegistry.Registries.name | String | The name of the resource. |
| Azure.ContainerRegistry.Registries.properties.adminUserEnabled | Boolean | The value that indicates whether the admin user is enabled. |
| Azure.ContainerRegistry.Registries.properties.anonymousPullEnabled | Boolean | Enables registry-wide pull from unauthenticated clients. |
| Azure.ContainerRegistry.Registries.properties.creationDate | String | The creation date of the container registry in ISO8601 format. |
| Azure.ContainerRegistry.Registries.properties.dataEndpointEnabled | Boolean | Enable a single data endpoint per region for serving data. |
| Azure.ContainerRegistry.Registries.properties.dataEndpointHostNames | Unknown | List of host names that will serve data when dataEndpointEnabled is true. |
| Azure.ContainerRegistry.Registries.properties.encryption | Unknown | The encryption settings of container registry. |
| Azure.ContainerRegistry.Registries.properties.loginServer | String | The URL that can be used to log into the container registry. |
| Azure.ContainerRegistry.Registries.properties.networkRuleBypassOptions | String | Whether to allow trusted Azure services to access a network restricted registry. |
| Azure.ContainerRegistry.Registries.properties.networkRuleSet | Unknown | The network rule set for a container registry. |
| Azure.ContainerRegistry.Registries.properties.policies | Unknown | The policies for a container registry. |
| Azure.ContainerRegistry.Registries.properties.privateEndpointConnections | Unknown | List of private endpoint connections for a container registry. |
| Azure.ContainerRegistry.Registries.properties.provisioningState | String | The provisioning state of the container registry at the time the operation was called. |
| Azure.ContainerRegistry.Registries.properties.publicNetworkAccess | String | Whether or not public network access is allowed for the container registry. |
| Azure.ContainerRegistry.Registries.properties.status | Unknown | The status of the container registry at the time the operation was called. |
| Azure.ContainerRegistry.Registries.properties.zoneRedundancy | String | Whether or not zone redundancy is enabled for this container registry. |
| Azure.ContainerRegistry.Registries.sku | Unknown | The SKU of the container registry. |
| Azure.ContainerRegistry.Registries.systemData | Unknown | Metadata pertaining to creation and last modification of the resource. |
| Azure.ContainerRegistry.Registries.tags | Unknown | The tags of the resource. |
| Azure.ContainerRegistry.Registries.type | String | The type of the resource. |
azure-storage-blob-service-property-get#
Run this command to get the blob service properties of a specific account storage. Required permissions: Microsoft.Storage/storageAccounts/blobServices/read.
Base Command#
azure-storage-blob-service-property-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The resource group name. | Required |
| account_name | The storage account name. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.BlobServices.id | String | Fully qualified resource ID for the resource. |
| Azure.Storage.BlobServices.name | String | The name of the resource. |
| Azure.Storage.BlobServices.type | String | The resource type. |
| Azure.Storage.BlobServices.properties.lastAccessTimeTrackingPolicy | Unknown | The blob service property to configure last access time based tracking policy. |
| Azure.Storage.BlobServices.properties.changeFeed | Unknown | The blob service properties for change feed events. |
| Azure.Storage.BlobServices.properties.containerDeleteRetentionPolicy | Unknown | The blob service properties for container soft delete. |
| Azure.Storage.BlobServices.properties.cors | Unknown | The CORS rules for the Blob service. |
| Azure.Storage.BlobServices.properties.defaultServiceVersion | String | The default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
| Azure.Storage.BlobServices.properties.deleteRetentionPolicy | Unknown | The blob service properties for blob soft delete. |
| Azure.Storage.BlobServices.properties.isVersioningEnabled | Boolean | Whether versioning is enabled. |
| Azure.Storage.BlobServices.properties.restorePolicy | Unknown | The blob service properties for blob restore policy. |
| Azure.Storage.BlobServices.sku.name | String | The SKU name. |
| Azure.Storage.BlobServices.sku.tier | String | The SKU tier. |
azure-storage-blob-service-property-set#
Sets properties for the blob service in a specific account storage. Required permissions: Microsoft.Storage/storageAccounts/blobServices/read, Microsoft.Storage/storageAccounts/blobServices/write.
Base Command#
azure-storage-blob-service-property-set
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The resource group name. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| delete_retention_policy_enabled | Whether DeleteRetentionPolicy is enabled. Possible values are: true, false. | Optional |
| delete_retention_policy_days | The number of days the deleted item should be retained. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.BlobServices.id | String | The resource ID. |
| Azure.Storage.BlobServices.name | String | The name of the resource. |
| Azure.Storage.BlobServices.type | String | The type of the resource. |
| Azure.Storage.BlobServices.properties.cors | Unknown | The CORS rules for the Blob service. |
| Azure.Storage.BlobServices.properties.defaultServiceVersion | String | The default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
| Azure.Storage.BlobServices.properties.deleteRetentionPolicy | Unknown | The service properties for soft delete. |
| Azure.Storage.BlobServices.properties.isVersioningEnabled | Boolean | Whether versioning is enabled. |
| Azure.Storage.BlobServices.properties.changeFeed | Unknown | The blob service properties for change feed events. |
| Azure.Storage.BlobServices.properties.containerDeleteRetentionPolicy | Unknown | The blob service properties for container soft delete. |
| Azure.Storage.BlobServices.properties.lastAccessTimeTrackingPolicy | Unknown | The blob service property to configure last access time based tracking policy. |
| Azure.Storage.BlobServices.properties.restorePolicy | Unknown | The blob service properties for blob restore policy. |
| Azure.Storage.BlobServices.sku.name | String | The SKU name. |
| Azure.Storage.BlobServices.sku.tier | String | The SKU tier. |
azure-vn-firewall-policy-rule-collection-groups-create#
Creates a rule collection group in a firewall policy. The group contains a network rule collection with a single network rule. Required permissions: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/write.
Base Command#
azure-vn-firewall-policy-rule-collection-groups-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the firewall policy in which to create the rule collection group. | Required |
| collection_name | The name of the network rule collection to create. | Required |
| collection_priority | The priority of the network rule collection. Must be between 100 and 65000. | Required |
| action | The action type of the network rule collection. Possible values are: Allow, Deny. | Required |
| rule_name | The name of the network rule to create in the collection. | Required |
| description | The description of the created network rule. | Optional |
| protocols | A comma-separated list of protocols for the created network rule. Possible values are: TCP, UDP, ICMP, Any. | Required |
| source_type | The source type of the created network rule. Possible values are: ip_address, ip_group. | Required |
| source_ips | A comma-separated list of source IP addresses for the created network rule. Required when source_type is ip_address. | Optional |
| source_ip_group_ids | A comma-separated list of source IP group IDs for the created network rule. Required when source_type is ip_group. | Optional |
| destination_type | The destination type of the created network rule. Possible values are: ip_address, ip_group, service_tag, fqdn. | Required |
| destinations | A comma-separated list of destinations for the created network rule. Must match the value of destination_type. Supports IP addresses, IP group IDs, service tag names, and FQDNs. | Required |
| destination_ports | A comma-separated list of destination ports for the created network rule. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.name | String | The name of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.id | String | The ID of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.type | String | The type of the firewall policy rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.etag | String | The ETag of the firewall policy rule collection group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.priority | Number | The priority of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.provisioningState | String | The provisioning state of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.ruleCollections | Unknown | The rule collections of the group, containing the ruleCollectionType, name, priority, action, and rules fields of each collection. |
azure-vn-firewall-policy-rule-collection-groups-update#
Updates the priority or the action of a network rule collection in a firewall policy rule collection group. Required permissions: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/write.
Base Command#
azure-vn-firewall-policy-rule-collection-groups-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the firewall policy that contains the rule collection group. | Required |
| collection_name | The name of the network rule collection to update. | Required |
| priority | The new priority of the network rule collection. Must be between 100 and 65000. It is mandatory to provide priority, action, or both. | Optional |
| action | The new action type of the network rule collection. It is mandatory to provide priority, action, or both. Possible values are: Allow, Deny. | Optional |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.name | String | The name of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.id | String | The ID of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.type | String | The type of the firewall policy rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.etag | String | The ETag of the firewall policy rule collection group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.priority | Number | The priority of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.provisioningState | String | The provisioning state of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.ruleCollections | Unknown | The rule collections of the group, containing the ruleCollectionType, name, priority, action, and rules fields of each collection. |
azure-vn-firewall-policy-rule-collection-groups-delete#
Deletes a rule collection group from a firewall policy. Required permissions: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/delete.
Base Command#
azure-vn-firewall-policy-rule-collection-groups-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the firewall policy that contains the rule collection group. | Required |
| collection_name | The name of the rule collection group to delete. This is the network rule collection name that was used when the group was created. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
There is no context output for this command.
azure-firewall-network-rule-create#
Creates a network rule in an existing network rule collection of an Azure Firewall. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-network-rule-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure Firewall that contains the network rule collection. | Required |
| collection_name | The name of the network rule collection in which to create the network rule. | Required |
| rule_name | The name of the network rule to create. | Required |
| description | The description of the created network rule. | Optional |
| protocols | A comma-separated list of protocols for the created network rule. Possible values are: TCP, UDP, ICMP, Any. | Required |
| source_type | The source type of the created network rule. Possible values are: ip_address, ip_group. | Required |
| source_ips | A comma-separated list of source IP addresses for the created network rule. Required when source_type is ip_address. | Optional |
| source_ip_group_ids | A comma-separated list of source IP group IDs for the created network rule. Required when source_type is ip_group. | Optional |
| destination_type | The destination type of the created network rule. Possible values are: ip_address, ip_group, service_tag, fqdn. | Required |
| destinations | A comma-separated list of destinations for the created network rule. Must match the value of destination_type. Supports IP addresses, IP group IDs, service tag names, and FQDNs. | Required |
| destination_ports | A comma-separated list of destination ports for the created network rule. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.name | String | The name of the Azure Firewall. |
| Azure.Firewall.Firewalls.id | String | The ID of the Azure Firewall. |
| Azure.Firewall.Firewalls.type | String | The type of the Azure Firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the Azure Firewall. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the Azure Firewall. The ETag prevents concurrent updates from overwriting each other. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the Azure Firewall. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the Azure Firewall, containing the name, etag, id, and properties fields of each collection. |
azure-firewall-network-rule-update#
Updates a network rule in a network rule collection of an Azure Firewall. Only the provided properties are replaced. The rest of the rule configuration remains unchanged. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-network-rule-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure Firewall that contains the network rule collection. | Required |
| collection_name | The name of the network rule collection that contains the network rule. | Required |
| rule_name | The name of the network rule to update. | Required |
| description | The new description of the network rule. | Optional |
| protocols | A comma-separated list of protocols that replaces the protocols of the network rule. Possible values are: TCP, UDP, ICMP, Any. | Optional |
| source_type | The new source type of the network rule. If provided, you must also provide source_ips or source_ip_group_ids. Possible values are: ip_address, ip_group. | Optional |
| source_ips | A comma-separated list of source IP addresses that replaces the sources of the network rule. Required when source_type is ip_address. | Optional |
| source_ip_group_ids | A comma-separated list of source IP group IDs that replaces the sources of the network rule. Required when source_type is ip_group. | Optional |
| destination_type | The new destination type of the network rule. Required when destinations is provided. Possible values are: ip_address, ip_group, service_tag, fqdn. | Optional |
| destinations | A comma-separated list of destinations that replaces the destinations of the network rule. Must match the value of destination_type. Supports IP addresses, IP group IDs, service tag names, and FQDNs. | Optional |
| destination_ports | A comma-separated list of destination ports that replaces the destination ports of the network rule. | Optional |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.name | String | The name of the Azure Firewall. |
| Azure.Firewall.Firewalls.id | String | The ID of the Azure Firewall. |
| Azure.Firewall.Firewalls.type | String | The type of the Azure Firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the Azure Firewall. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the Azure Firewall. The ETag prevents concurrent updates from overwriting each other. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the Azure Firewall. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the Azure Firewall, containing the name, etag, id, and properties fields of each collection. |
azure-firewall-network-rule-delete#
Deletes network rules from a network rule collection of an Azure Firewall. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-network-rule-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure Firewall that contains the network rule collection. | Required |
| collection_name | The name of the network rule collection that contains the network rules. | Required |
| rule_names | A comma-separated list of network rule names to delete from the collection. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.name | String | The name of the Azure Firewall. |
| Azure.Firewall.Firewalls.id | String | The ID of the Azure Firewall. |
| Azure.Firewall.Firewalls.type | String | The type of the Azure Firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the Azure Firewall. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the Azure Firewall. The ETag prevents concurrent updates from overwriting each other. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the Azure Firewall. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the Azure Firewall, containing the name, etag, id, and properties fields of each collection. |
azure-auth-test#
Tests the connectivity to Azure. Relevant for the Device Code and Authorization Code authentication flows (used instead of the Test button for these interactive flows).
Base Command#
azure-auth-test
Input#
There are no input arguments for this command.
Context Output#
There is no context output for this command.
azure-generate-login-url#
Generates the login URL used for authorization. Relevant only for the Authorization Code authentication flow.
Base Command#
azure-generate-login-url
Input#
There are no input arguments for this command.
Context Output#
There is no context output for this command.
azure-auth-complete#
Completes the authorization process for the Device Code flow. Should be used after running the azure-auth-start command.
Base Command#
azure-auth-complete
Input#
There are no input arguments for this command.
Context Output#
There is no context output for this command.
azure-auth-reset#
Resets the authentication process. Relevant for the Device Code and Authorization Code authentication flows.
Base Command#
azure-auth-reset
Input#
There are no input arguments for this command.
Context Output#
There is no context output for this command.
azure-auth-start#
Starts the authorization process for the Device Code / Authorization Code flows. Follow the instructions in the command results.
Base Command#
azure-auth-start
Input#
There are no input arguments for this command.
Context Output#
There is no context output for this command.
azure-firewall-policy-detach#
Detaches the firewall policy from a firewall. The command detaches the policy from the firewall, but does not delete the policy. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-policy-detach
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| firewall_name | The name of the firewall from which the policy is detached. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.id | String | The firewall resource ID. |
| Azure.Firewall.Firewalls.name | String | The firewall resource name. |
| Azure.Firewall.Firewalls.type | String | The firewall resource type. |
| Azure.Firewall.Firewalls.location | String | The firewall resource location. |
| Azure.Firewall.Firewalls.etag | String | The unique read-only string that changes whenever the resource is updated. |
| Azure.Firewall.Firewalls.tags | Unknown | The firewall resource tags. |
| Azure.Firewall.Firewalls.zones | Unknown | A list of availability zones from which the resource originates. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the firewall resource. Possible values are "Succeeded", "Updating", "Deleting", or "Failed". |
| Azure.Firewall.Firewalls.properties.threatIntelMode | String | The threat intelligence operation mode. |
| Azure.Firewall.Firewalls.properties.firewallPolicy | Unknown | The firewall policy object associated with the firewall containing the id field. |
| Azure.Firewall.Firewalls.properties.sku | Unknown | The SKU object of the firewall containing the name and tier fields. |
| Azure.Firewall.Firewalls.properties.ipConfigurations | Unknown | The IP configurations of the firewall resource. |
| Azure.Firewall.Firewalls.properties.hubIPAddresses | Unknown | The IP addresses associated with the firewall resource. |
| Azure.Firewall.Firewalls.properties.virtualHub | Unknown | The virtual hub object to which the firewall belongs containing the id field. |
| Azure.Firewall.Firewalls.properties.managementIpConfiguration | Unknown | The management IP configuration of the firewall resource used for forced tunneling. |
| Azure.Firewall.Firewalls.properties.applicationRuleCollections | Unknown | A list of application rule collections of the firewall resource. Returned only when the firewall is not managed by a firewall policy. |
| Azure.Firewall.Firewalls.properties.natRuleCollections | Unknown | A list of NAT rule collections of the firewall resource. Returned only when the firewall is not managed by a firewall policy. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | A list of network rule collections of the firewall resource. Returned only when the firewall is not managed by a firewall policy. |
| Azure.Firewall.Firewalls.properties.ipGroups | Unknown | A list of IP groups associated with the firewall resource. |
| Azure.Firewall.Firewalls.properties.autoscaleConfiguration | Unknown | The autoscale settings of the firewall resource containing the minCapacity and maxCapacity fields. |
| Azure.Firewall.Firewalls.properties.additionalProperties | Unknown | The additional properties used to further configure the firewall resource. |
azure-vn-firewall-policy-get#
Retrieves a firewall policy. Required permission: Microsoft.Network/firewallPolicies/read.
Base Command#
azure-vn-firewall-policy-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the firewall policy to retrieve. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicies.id | String | The firewall policy resource ID. |
| Azure.VirtualNetworks.FirewallPolicies.name | String | The firewall policy resource name. |
| Azure.VirtualNetworks.FirewallPolicies.type | String | The firewall policy resource type. |
| Azure.VirtualNetworks.FirewallPolicies.location | String | The firewall policy resource location. |
| Azure.VirtualNetworks.FirewallPolicies.etag | String | The unique read-only string that changes whenever the resource is updated. |
| Azure.VirtualNetworks.FirewallPolicies.tags | Unknown | The firewall policy resource tags. |
| Azure.VirtualNetworks.FirewallPolicies.identity | Unknown | The managed identity of the firewall policy containing the type, principalId, tenantId, and userAssignedIdentities fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.provisioningState | String | The provisioning state of the firewall policy resource. Possible values are "Succeeded", "Updating", "Deleting", or "Failed". |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelMode | String | The threat intelligence operation mode. |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelWhitelist | Unknown | The threat intelligence allow list object containing the ipAddresses and fqdns fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.dnsSettings | Unknown | The DNS settings object containing the servers, enableProxy, and requireProxyForNetworkRules fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sku | Unknown | The SKU object of the firewall policy containing the tier field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.basePolicy | Unknown | The parent firewall policy object from which rules are inherited containing the id field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.firewalls | Unknown | A list of references to Azure Firewalls associated with the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.childPolicies | Unknown | A list of references to child firewall policies. |
| Azure.VirtualNetworks.FirewallPolicies.properties.ruleCollectionGroups | Unknown | A list of references to rule collection groups of the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.size | String | The size of the firewall policy, in MB (for example, 0.5 MB). |
| Azure.VirtualNetworks.FirewallPolicies.properties.insights | Unknown | The insights settings of the firewall policy containing the isEnabled, retentionDays, and logAnalyticsResources fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.snat | Unknown | The private IP address ranges to which traffic is not SNATed containing the privateRanges and autoLearnPrivateRanges fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sql | Unknown | The SQL settings of the firewall policy containing the allowSqlRedirect field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.explicitProxy | Unknown | The explicit proxy settings of the firewall policy containing the enableExplicitProxy, httpPort, httpsPort, enablePacFile, pacFilePort, and pacFile fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.intrusionDetection | Unknown | The intrusion detection settings of the firewall policy containing the mode, profile, and configuration fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.transportSecurity | Unknown | The TLS inspection settings of the firewall policy containing the certificateAuthority field. |
azure-vn-firewall-policy-delete#
Deletes a firewall policy resource. Required permission: Microsoft.Network/firewallPolicies/delete.
Base Command#
azure-vn-firewall-policy-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the firewall policy to delete. | Required |
Context Output#
There is no context output for this command.
azure-vn-firewall-policy-list#
Lists the firewall policies in a resource group. Use the next_token argument to view the next page of results. Required permission: Microsoft.Network/firewallPolicies/read.
Base Command#
azure-vn-firewall-policy-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| next_token | The URI to fetch the next page of results as returned in the Azure.VirtualNetworks.FirewallPoliciesNextToken output of a previous run. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicies.id | String | The firewall policy resource ID. |
| Azure.VirtualNetworks.FirewallPolicies.name | String | The firewall policy resource name. |
| Azure.VirtualNetworks.FirewallPolicies.type | String | The firewall policy resource type. |
| Azure.VirtualNetworks.FirewallPolicies.location | String | The firewall policy resource location. |
| Azure.VirtualNetworks.FirewallPolicies.etag | String | The unique read-only string that changes whenever the resource is updated. |
| Azure.VirtualNetworks.FirewallPolicies.tags | Unknown | The firewall policy resource tags. |
| Azure.VirtualNetworks.FirewallPolicies.identity | Unknown | The managed identity of the firewall policy containing the type, principalId, tenantId, and userAssignedIdentities fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.provisioningState | String | The provisioning state of the firewall policy resource. Possible values are "Succeeded", "Updating", "Deleting", or "Failed". |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelMode | String | The threat intelligence operation mode. |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelWhitelist | Unknown | The threat intelligence allow list object containing the ipAddresses and fqdns fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.dnsSettings | Unknown | The DNS settings object containing the servers, enableProxy, and requireProxyForNetworkRules fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sku | Unknown | The SKU object of the firewall policy containing the tier field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.basePolicy | Unknown | The parent firewall policy object from which rules are inherited containing the id field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.firewalls | Unknown | A list of references to Azure Firewalls associated with the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.childPolicies | Unknown | A list of references to child firewall policies. |
| Azure.VirtualNetworks.FirewallPolicies.properties.ruleCollectionGroups | Unknown | A list of references to rule collection groups of the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.size | String | The size of the firewall policy, in MB (for example, 0.5 MB). |
| Azure.VirtualNetworks.FirewallPolicies.properties.insights | Unknown | The insights settings of the firewall policy containing the isEnabled, retentionDays, and logAnalyticsResources fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.snat | Unknown | The private IP address ranges to which traffic is not SNATed containing the privateRanges and autoLearnPrivateRanges fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sql | Unknown | The SQL settings of the firewall policy containing the allowSqlRedirect field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.explicitProxy | Unknown | The explicit proxy settings of the firewall policy containing the enableExplicitProxy, httpPort, httpsPort, enablePacFile, pacFilePort, and pacFile fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.intrusionDetection | Unknown | The intrusion detection settings of the firewall policy containing the mode, profile, and configuration fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.transportSecurity | Unknown | The TLS inspection settings of the firewall policy containing the certificateAuthority field. |
| Azure.VirtualNetworks.FirewallPoliciesNextToken | String | The URI to fetch the next page of firewall policies. Run the same command with the next_token argument to get the next page. |
azure-firewall-policy-attach#
Attaches a firewall policy to a firewall. The policy and the firewall must belong to the same tier. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write, Microsoft.Network/firewallPolicies/join/action.
Base Command#
azure-firewall-policy-attach
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| firewall_name | The name of the firewall to which the policy is attached. | Required |
| policy_id | The ID of the firewall policy to attach. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.id | String | The firewall resource ID. |
| Azure.Firewall.Firewalls.name | String | The firewall resource name. |
| Azure.Firewall.Firewalls.type | String | The firewall resource type. |
| Azure.Firewall.Firewalls.location | String | The firewall resource location. |
| Azure.Firewall.Firewalls.etag | String | The unique read-only string that changes whenever the resource is updated. |
| Azure.Firewall.Firewalls.tags | Unknown | The firewall resource tags. |
| Azure.Firewall.Firewalls.zones | Unknown | A list of availability zones from which the resource originates. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the firewall resource. Possible values are "Succeeded", "Updating", "Deleting", or "Failed". |
| Azure.Firewall.Firewalls.properties.threatIntelMode | String | The threat intelligence operation mode. |
| Azure.Firewall.Firewalls.properties.firewallPolicy | Unknown | The firewall policy object associated with the firewall containing the id field. |
| Azure.Firewall.Firewalls.properties.sku | Unknown | The SKU object of the firewall containing the name and tier fields. |
| Azure.Firewall.Firewalls.properties.ipConfigurations | Unknown | The IP configurations of the firewall resource. |
| Azure.Firewall.Firewalls.properties.hubIPAddresses | Unknown | The IP addresses associated with the firewall resource. |
| Azure.Firewall.Firewalls.properties.virtualHub | Unknown | The virtual hub object to which the firewall belongs containing the id field. |
| Azure.Firewall.Firewalls.properties.managementIpConfiguration | Unknown | The management IP configuration of the firewall resource used for forced tunneling. |
| Azure.Firewall.Firewalls.properties.applicationRuleCollections | Unknown | A list of application rule collections of the firewall resource. Returned only when the firewall is not managed by a firewall policy. |
| Azure.Firewall.Firewalls.properties.natRuleCollections | Unknown | A list of NAT rule collections of the firewall resource. Returned only when the firewall is not managed by a firewall policy. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | A list of network rule collections of the firewall resource. Returned only when the firewall is not managed by a firewall policy. |
| Azure.Firewall.Firewalls.properties.ipGroups | Unknown | A list of IP groups associated with the firewall resource. |
| Azure.Firewall.Firewalls.properties.autoscaleConfiguration | Unknown | The autoscale settings of the firewall resource containing the minCapacity and maxCapacity fields. |
| Azure.Firewall.Firewalls.properties.additionalProperties | Unknown | The additional properties used to further configure the firewall resource. |
azure-vn-firewall-policy-update#
Updates a firewall policy. Only provided arguments are updated. Required permissions: Microsoft.Network/firewallPolicies/read, Microsoft.Network/firewallPolicies/write.
Base Command#
azure-vn-firewall-policy-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the firewall policy to update. | Required |
| threat_intelligence_mode | The threat intelligence operation mode. Possible values are: Alert, Deny, Off. | Optional |
| ips | The comma-separated list of IP addresses for the threat intelligence allow list. | Optional |
| domains | The comma-separated list of fully qualified domain names for the threat intelligence allow list (for example, "*.microsoft.com,email.college.edu"). | Optional |
| base_policy_id | The ID of the parent firewall policy from which rules are inherited. | Optional |
| enable_proxy | Whether to enable the DNS proxy on firewalls attached to the firewall policy. Possible values are: true, false. | Optional |
| dns_servers | The comma-separated list of custom DNS servers. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicies.id | String | The firewall policy resource ID. |
| Azure.VirtualNetworks.FirewallPolicies.name | String | The firewall policy resource name. |
| Azure.VirtualNetworks.FirewallPolicies.type | String | The firewall policy resource type. |
| Azure.VirtualNetworks.FirewallPolicies.location | String | The firewall policy resource location. |
| Azure.VirtualNetworks.FirewallPolicies.etag | String | The unique read-only string that changes whenever the resource is updated. |
| Azure.VirtualNetworks.FirewallPolicies.tags | Unknown | The firewall policy resource tags. |
| Azure.VirtualNetworks.FirewallPolicies.identity | Unknown | The managed identity of the firewall policy containing the type, principalId, tenantId, and userAssignedIdentities fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.provisioningState | String | The provisioning state of the firewall policy resource. Possible values are "Succeeded", "Updating", "Deleting", or "Failed". |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelMode | String | The threat intelligence operation mode. |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelWhitelist | Unknown | The threat intelligence allow list object containing the ipAddresses and fqdns fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.dnsSettings | Unknown | The DNS settings object containing the servers, enableProxy, and requireProxyForNetworkRules fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sku | Unknown | The SKU object of the firewall policy containing the tier field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.basePolicy | Unknown | The parent firewall policy object from which rules are inherited containing the id field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.firewalls | Unknown | A list of references to the Azure Firewalls associated with the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.childPolicies | Unknown | A list of references to child firewall policies. |
| Azure.VirtualNetworks.FirewallPolicies.properties.ruleCollectionGroups | Unknown | A list of references to rule collection groups of the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.size | String | The size of the firewall policy, in MB (for example, 0.5 MB). |
| Azure.VirtualNetworks.FirewallPolicies.properties.insights | Unknown | The insights settings of the firewall policy containing the isEnabled, retentionDays, and logAnalyticsResources fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.snat | Unknown | The private IP address ranges to which traffic is not SNATed containing the privateRanges and autoLearnPrivateRanges fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sql | Unknown | The SQL settings of the firewall policy containing the allowSqlRedirect field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.explicitProxy | Unknown | The explicit proxy settings of the firewall policy containing the enableExplicitProxy, httpPort, httpsPort, enablePacFile, pacFilePort, and pacFile fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.intrusionDetection | Unknown | The intrusion detection settings of the firewall policy containing the mode, profile, and configuration fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.transportSecurity | Unknown | The TLS inspection settings of the firewall policy containing the certificateAuthority field. |
azure-vn-firewall-policy-create#
Creates a firewall policy. This command only creates the policy resource. To attach the policy to a firewall, run the azure-firewall-policy-attach command. Required permissions: Microsoft.Network/firewallPolicies/read, Microsoft.Network/firewallPolicies/write.
Base Command#
azure-vn-firewall-policy-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the firewall policy to create. | Required |
| location | The region location of the firewall policy resource. | Required |
| tier | The tier of the firewall policy. Possible values are: Standard, Premium, Basic. Default is Standard. | Required |
| threat_intelligence_mode | The operation mode for threat intelligence. Possible values are: Alert, Deny, Off. | Optional |
| ips | The comma-separated list of IP addresses for the threat intelligence allow list. | Optional |
| domains | The comma-separated list of fully qualified domain names for the threat intelligence allow list (for example, "*.microsoft.com,email.college.edu"). | Optional |
| base_policy_id | The ID of the parent firewall policy from which rules are inherited. | Optional |
| enable_proxy | Whether to enable the DNS proxy on the firewalls attached to the firewall policy. Possible values are: true, false. | Optional |
| dns_servers | The comma-separated list of custom DNS servers. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicies.id | String | The firewall policy resource ID. |
| Azure.VirtualNetworks.FirewallPolicies.name | String | The firewall policy resource name. |
| Azure.VirtualNetworks.FirewallPolicies.type | String | The firewall policy resource type. |
| Azure.VirtualNetworks.FirewallPolicies.location | String | The firewall policy resource location. |
| Azure.VirtualNetworks.FirewallPolicies.etag | String | The unique read-only string that changes whenever the resource is updated. |
| Azure.VirtualNetworks.FirewallPolicies.tags | Unknown | The firewall policy resource tags. |
| Azure.VirtualNetworks.FirewallPolicies.identity | Unknown | The managed identity of the firewall policy, containing the type, principalId, tenantId, and userAssignedIdentities fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.provisioningState | String | The provisioning state of the firewall policy resource. Possible values are "Succeeded", "Updating", "Deleting", or "Failed". |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelMode | String | The operation mode for threat intelligence. |
| Azure.VirtualNetworks.FirewallPolicies.properties.threatIntelWhitelist | Unknown | The threat intelligence allow list object containing the ipAddresses and fqdns fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.dnsSettings | Unknown | The DNS settings object containing the servers, enableProxy, and requireProxyForNetworkRules fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sku | Unknown | The SKU object of the firewall policy containing the tier field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.basePolicy | Unknown | The parent firewall policy object from which rules are inherited containing the id field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.firewalls | Unknown | A list of references to Azure Firewalls associated with the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.childPolicies | Unknown | A list of references to child firewall policies. |
| Azure.VirtualNetworks.FirewallPolicies.properties.ruleCollectionGroups | Unknown | A list of references to rule collection groups of the firewall policy. |
| Azure.VirtualNetworks.FirewallPolicies.properties.size | String | The size of the firewall policy, in MB (for example, 0.5 MB). |
| Azure.VirtualNetworks.FirewallPolicies.properties.insights | Unknown | The insights settings of the firewall policy containing the isEnabled, retentionDays, and logAnalyticsResources fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.snat | Unknown | The private IP address ranges to which traffic is not SNATed containing the privateRanges and autoLearnPrivateRanges fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.sql | Unknown | The SQL settings of the firewall policy containing the allowSqlRedirect field. |
| Azure.VirtualNetworks.FirewallPolicies.properties.explicitProxy | Unknown | The explicit proxy settings of the firewall policy containing the enableExplicitProxy, httpPort, httpsPort, enablePacFile, pacFilePort, and pacFile fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.intrusionDetection | Unknown | The intrusion detection settings of the firewall policy containing the mode, profile, and configuration fields. |
| Azure.VirtualNetworks.FirewallPolicies.properties.transportSecurity | Unknown | The TLS inspection settings of the firewall policy containing the certificateAuthority field. |
azure-application-gateway-waf-policy-get#
Retrieves an Application Gateway Web Application Firewall (WAF) policy by name. Required permission: Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/read.
Base Command#
azure-application-gateway-waf-policy-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group containing the policy. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the WAF policy to retrieve. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ApplicationGateway.WAFPolicies.id | String | The resource ID of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.name | String | The name of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.type | String | The resource type of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.location | String | The location of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.etag | String | The ETag used to prevent concurrent updates from overwriting the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.tags | Unknown | The tags of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.sku | Unknown | The WAF policy pricing tier containing the name field. |
| Azure.ApplicationGateway.WAFPolicies.properties.provisioningState | String | The provisioning state of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.properties.resourceState | String | The resource state of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.properties.policySettings | Unknown | The policy settings object containing the mode, state, requestBodyCheck, maxRequestBodySizeInKb, and fileUploadLimitInMb fields. |
| Azure.ApplicationGateway.WAFPolicies.properties.customRules | Unknown | The custom rules of the policy, each containing the name, priority, ruleType, matchConditions, and action fields. |
| Azure.ApplicationGateway.WAFPolicies.properties.managedRules | Unknown | The managed rules of the policy containing the managedRuleSets, exclusions, and exceptions fields. |
azure-application-gateway-waf-policies-list#
Lists the Application Gateway Web Application Firewall (WAF) policies of a resource group, or of the whole subscription when no resource group is given. Required permission: Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/read.
Base Command#
azure-application-gateway-waf-policies-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group from which to list policies. If not specified, lists policies for the entire subscription. | Optional |
| next_token | The URI used to fetch the next page of results. Set to the value of the Azure.ApplicationGateway.WAFPoliciesNextToken context output from the previous response. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ApplicationGateway.WAFPolicies.id | String | The resource ID of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.name | String | The name of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.type | String | The resource type of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.location | String | The location of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.etag | String | The ETag used to prevent concurrent updates from overwriting the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.tags | Unknown | The tags of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.sku | Unknown | The WAF policy pricing tier containing the name field. |
| Azure.ApplicationGateway.WAFPolicies.properties.provisioningState | String | The provisioning state of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.properties.resourceState | String | The resource state of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.properties.policySettings | Unknown | The policy settings object containing the mode, state, requestBodyCheck, maxRequestBodySizeInKb, and fileUploadLimitInMb fields. |
| Azure.ApplicationGateway.WAFPolicies.properties.customRules | Unknown | The custom rules of the policy, each containing the name, priority, ruleType, matchConditions, and action fields. |
| Azure.ApplicationGateway.WAFPolicies.properties.managedRules | Unknown | The managed rules of the policy containing the managedRuleSets, exclusions, and exceptions fields. |
| Azure.ApplicationGateway.WAFPoliciesNextToken | String | The URI used to fetch the next page of policies. Pass this value to the next_token argument to retrieve the next page. |
azure-application-gateway-waf-policy-create-or-update#
Creates an Application Gateway Web Application Firewall (WAF) policy, or fully replaces an existing one. Warning: this is a full replacement and not a partial update. Any property that is not provided as an argument is removed from the policy or reset to its default, since the policy is not read before it is written. Required permission: Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/write.
Base Command#
azure-application-gateway-waf-policy-create-or-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group to create the policy in. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the WAF policy to create or update. | Required |
| location | The Azure region of the policy. For example "westus2". | Required |
| managed_rules | The managed rules of the policy, as a JSON string. For example, {"managedRuleSets": [{"ruleSetType": "OWASP", "ruleSetVersion": "3.2"}]}. | Required |
| policy_settings | The policy settings, as a JSON string. For example, {"mode": "Prevention", "state": "Enabled"}. | Optional |
| custom_rules | The custom rules of the policy, as a JSON string containing a list of rule objects. | Optional |
| tags | The tags to assign to the policy, as a JSON string. For example, {"env": "prod"}. | Optional |
| resource_id | The resource ID of the policy. Used when updating an existing policy. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ApplicationGateway.WAFPolicies.id | String | The resource ID of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.name | String | The name of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.type | String | The resource type of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.location | String | The location of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.etag | String | The ETag used to prevent concurrent updates from overwriting the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.tags | Unknown | The tags of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.sku | Unknown | The WAF policy pricing tier containing the name field. |
| Azure.ApplicationGateway.WAFPolicies.properties.provisioningState | String | The provisioning state of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.properties.resourceState | String | The resource state of the WAF policy. |
| Azure.ApplicationGateway.WAFPolicies.properties.policySettings | Unknown | The policy settings object containing the mode, state, requestBodyCheck, maxRequestBodySizeInKb, and fileUploadLimitInMb fields. |
| Azure.ApplicationGateway.WAFPolicies.properties.customRules | Unknown | The custom rules of the policy, each containing the name, priority, ruleType, matchConditions, and action fields. |
| Azure.ApplicationGateway.WAFPolicies.properties.managedRules | Unknown | The managed rules of the policy containing the managedRuleSets, exclusions, and exceptions fields. |
azure-application-gateway-waf-policy-delete#
Deletes an Application Gateway Web Application Firewall (WAF) policy. Required permission: Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/delete.
Base Command#
azure-application-gateway-waf-policy-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group containing the policy. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the WAF policy to delete. | Required |
Context Output#
There is no context output for this command.
azure-front-door-policy-get#
Retrieves a Front Door Web Application Firewall (WAF) policy by name. Required permission: Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/read.
Base Command#
azure-front-door-policy-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group containing the policy. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the Front Door WAF policy to retrieve. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.FrontDoor.Policies.id | String | The resource ID of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.name | String | The name of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.type | String | The resource type of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.location | String | The location of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.etag | String | The ETag used to prevent concurrent updates from overwriting the Front Door WAF policy. |
| Azure.FrontDoor.Policies.tags | Unknown | The tags of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.sku | Unknown | The Front Door WAF policy pricing tier containing the name field. |
| Azure.FrontDoor.Policies.properties.provisioningState | String | The provisioning state of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.properties.resourceState | String | The resource state of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.properties.policySettings | Unknown | The policy settings object containing the mode, enabledState, redirectUrl, customBlockResponseStatusCode, and customBlockResponseBody fields. |
| Azure.FrontDoor.Policies.properties.customRules | Unknown | The custom rules of the policy containing the rules field. |
| Azure.FrontDoor.Policies.properties.managedRules | Unknown | The managed rules of the policy containing the managedRuleSets field. |
| Azure.FrontDoor.Policies.properties.frontendEndpointLinks | Unknown | The Front Door endpoints associated with the policy. |
azure-front-door-policies-list#
Lists the Front Door Web Application Firewall (WAF) policies of a resource group, or of the whole subscription when no resource group is given. Required permission: Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/read.
Base Command#
azure-front-door-policies-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group from which to list policies. When not provided, policies for the entire subscription are listed. | Optional |
| next_token | The URI used to fetch the next page of results. Set to the value of the Azure.FrontDoor.PoliciesNextToken context output from the previous response. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.FrontDoor.Policies.id | String | The resource ID of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.name | String | The name of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.type | String | The resource type of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.location | String | The location of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.etag | String | The ETag used to prevent concurrent updates from overwriting the Front Door WAF policy. |
| Azure.FrontDoor.Policies.tags | Unknown | The tags of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.sku | Unknown | The Front Door WAF policy pricing tier containing the name field. |
| Azure.FrontDoor.Policies.properties.provisioningState | String | The provisioning state of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.properties.resourceState | String | The resource state of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.properties.policySettings | Unknown | The policy settings object containing the mode, enabledState, redirectUrl, customBlockResponseStatusCode, and customBlockResponseBody fields. |
| Azure.FrontDoor.Policies.properties.customRules | Unknown | The custom rules of the policy containing the rules field. |
| Azure.FrontDoor.Policies.properties.managedRules | Unknown | The managed rules of the policy containing the managedRuleSets field. |
| Azure.FrontDoor.PoliciesNextToken | String | The URI used to fetch the next page of policies. Pass this value to the next_token argument to retrieve the next page. |
azure-front-door-policy-create-or-update#
Creates a Front Door Web Application Firewall (WAF) policy, or fully replaces an existing one. Warning: this is a full replacement and not a partial update. Any property that is not provided as an argument is removed from the policy or reset to its default, since the policy is not read before it is written. Required permission: Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/write.
Base Command#
azure-front-door-policy-create-or-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group to create the policy in. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the Front Door WAF policy to create or update. | Required |
| managed_rules | The managed rules of the policy, as a JSON string. For example, {"managedRuleSets": [{"ruleSetType": "DefaultRuleSet", "ruleSetVersion": "1.0"}]}. | Required |
| policy_settings | The policy settings, as a JSON string. For example, {"mode": "Prevention", "enabledState": "Enabled"}. | Optional |
| custom_rules | The custom rules of the policy, as a JSON string. For example, {"rules": []}. | Optional |
| location | The Azure region of the policy. Front Door WAF policies are global resources. Default is Global. | Optional |
| sku | The pricing tier of the policy. Possible values are: Classic_AzureFrontDoor, Standard_AzureFrontDoor, Premium_AzureFrontDoor. Default is Classic_AzureFrontDoor. | Optional |
| tags | The tags to assign to the policy, as a JSON string. For example, {"env": "prod"}. | Optional |
| etag | The ETag used to prevent concurrent updates from overwriting the WAF policy. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.FrontDoor.Policies.id | String | The resource ID of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.name | String | The name of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.type | String | The resource type of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.location | String | The location of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.etag | String | The ETag used to prevent concurrent updates from overwriting the Front Door WAF policy. |
| Azure.FrontDoor.Policies.tags | Unknown | The tags of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.sku | Unknown | The Front Door WAF policy pricing tier containing the name field. |
| Azure.FrontDoor.Policies.properties.provisioningState | String | The provisioning state of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.properties.resourceState | String | The resource state of the Front Door WAF policy. |
| Azure.FrontDoor.Policies.properties.policySettings | Unknown | The policy settings object containing the mode, enabledState, redirectUrl, customBlockResponseStatusCode, and customBlockResponseBody fields. |
| Azure.FrontDoor.Policies.properties.customRules | Unknown | The custom rules of the policy containing the rules field. |
| Azure.FrontDoor.Policies.properties.managedRules | Unknown | The managed rules of the policy containing the managedRuleSets field. |
azure-front-door-policy-delete#
Deletes a Front Door Web Application Firewall (WAF) policy. Required permission: Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/delete.
Base Command#
azure-front-door-policy-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group containing the policy. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| policy_name | The name of the Front Door WAF policy to delete. | Required |
Context Output#
There is no context output for this command.
azure-aks-managed-clusters-list#
Gets a list of managed clusters in the specified subscription. Requires the following permission: Microsoft.ContainerService/managedClusters/read.
Base Command#
azure-aks-managed-clusters-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| next_token | The token for the next set of items to return, used for pagination. Returned by a previous call as ManagedClusterNextToken. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.AKS.ManagedCluster.id | String | The resource ID. |
| Azure.AKS.ManagedCluster.location | String | The resource location. |
| Azure.AKS.ManagedCluster.name | String | The resource name. |
| Azure.AKS.ManagedCluster.tags | Unknown | The resource tags. |
| Azure.AKS.ManagedCluster.type | String | The resource type. |
| Azure.AKS.ManagedCluster.kind | String | The kind of the managed cluster, primarily used to expose different UI experiences in the portal. |
| Azure.AKS.ManagedCluster.sku | Unknown | The managed cluster SKU, including the name and tier. |
| Azure.AKS.ManagedCluster.identity | Unknown | The identity of the managed cluster, if configured. |
| Azure.AKS.ManagedCluster.properties.provisioningState | String | The current deployment or provisioning state, which only appears in the response. |
| Azure.AKS.ManagedCluster.properties.powerState | Unknown | The power state of the cluster, indicating whether it is running or stopped. |
| Azure.AKS.ManagedCluster.properties.kubernetesVersion | String | The version of Kubernetes specified when creating the managed cluster. |
| Azure.AKS.ManagedCluster.properties.currentKubernetesVersion | String | The version of Kubernetes the managed cluster is currently running. |
| Azure.AKS.ManagedCluster.properties.maxAgentPools | Number | The maximum number of agent pools of the managed cluster. |
| Azure.AKS.ManagedCluster.properties.dnsPrefix | String | The DNS prefix specified when creating the managed cluster. |
| Azure.AKS.ManagedCluster.properties.fqdn | String | The FQDN of the master pool. |
| Azure.AKS.ManagedCluster.properties.azurePortalFQDN | String | The special FQDN used by the Azure Portal to access the managed cluster. |
| Azure.AKS.ManagedCluster.properties.disableLocalAccounts | Boolean | Whether local accounts are disabled on the managed cluster. |
| Azure.AKS.ManagedCluster.properties.publicNetworkAccess | String | Whether public network access to the managed cluster is allowed or denied. |
| Azure.AKS.ManagedCluster.properties.agentPoolProfiles | Unknown | The agent pool profiles, including name, count, VM size, max pods, OS type, provisioning state, and orchestrator version. |
| Azure.AKS.ManagedCluster.properties.linuxProfile | Unknown | The Linux profile, including the administrator account name and SSH public keys used to authenticate with VMs. |
| Azure.AKS.ManagedCluster.properties.servicePrincipalProfile | Unknown | The service principal profile, including the client ID of the service principal. |
| Azure.AKS.ManagedCluster.properties.nodeResourceGroup | String | The name of the resource group containing agent pool nodes. |
| Azure.AKS.ManagedCluster.properties.enableRBAC | Boolean | Whether to enable Kubernetes Role-Based Access Control (RBAC). |
| Azure.AKS.ManagedCluster.properties.diskEncryptionSetID | String | The resource ID of the disk encryption set used to enable encryption at rest. |
| Azure.AKS.ManagedCluster.properties.networkProfile | Unknown | The network configuration, including the network plugin, pod CIDR, service CIDR, and DNS service IP. |
| Azure.AKS.ManagedCluster.properties.addonProfiles | Unknown | The managed cluster add-on profiles, including the Operations Management Suite Agent and HTTP application routing configurations. |
| Azure.AKS.ManagedClusterNextToken | String | The token for the next set of managed clusters, used for pagination. |
azure-aks-managed-cluster-addon-update#
Updates a managed cluster with the specified configuration. Requires the following permissions: Microsoft.ContainerService/managedClusters/read, Microsoft.ContainerService/managedClusters/write.
Base Command#
azure-aks-managed-cluster-addon-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_name | The name of the managed cluster resource. Can be retrieved using the azure-aks-managed-clusters-list command. | Required |
| location | The resource location. Can be retrieved using the azure-aks-managed-clusters-list command. Possible values are: australiacentral, australiacentral2, australiaeast, australiasoutheast, brazilse, brazilsouth, canadacentral, canadaeast, centralfrance, centralindia, centralus, centraluseuap, eastasia, eastus, eastus2, eastus2euap, germanyn, germanywc, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwaye, norwayw, southafricanorth, southafricawest, southcentralus, southeastasia, southfrance, southindia, switzerlandn, switzerlandw, uaecentral, uaenorth, uknorth, uksouth, uksouth2, ukwest, westcentralus, westeurope, westindia, westus, westus2. | Required |
| http_application_routing_enabled | Whether to configure ingress with automatic public DNS name creation. Possible values are: true, false. | Optional |
| monitoring_agent_enabled | Whether to turn on Log Analytics monitoring. If enabled and monitoring_resource_name is not specified, it uses the currently configured workspace resource ID. Possible values are: true, false. | Optional |
| monitoring_resource_name | The name of an existing Log Analytics workspace to use for storing monitoring data. Can be retrieved in the Log Analytics workspace from the Azure portal. | Optional |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
Context Output#
There is no context output for this command.
azure-storage-table-entity-query#
Queries entities in a table. Provide partition_key and row_key together to retrieve a single entity, or omit them to query multiple entities. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/entities/read.
Base Command#
azure-storage-table-entity-query
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table to query. | Required |
| partition_key | The PartitionKey property of a specific entity to retrieve. Must be provided together with row_key. | Optional |
| row_key | The RowKey property of a specific entity to retrieve. Must be provided together with partition_key. | Optional |
| filter | The OData query expression used to filter the returned entities. | Optional |
| select | The comma-separated list of entity properties to return. | Optional |
| limit | The maximum number of entities to return. Accepted range is 1 to 1000. Default is 50. Default is 50. | Optional |
| next_token | The continuation token returned by a previous call (Azure.Storage.EntitiesNextToken), used to retrieve the next page of results. Ignored when partition_key and row_key are provided. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Table.Entity.PartitionKey | String | The PartitionKey property of the entity. |
| Azure.Storage.Table.Entity.RowKey | String | The RowKey property of the entity. |
| Azure.Storage.Table.Entity.Timestamp | Date | The date and time the entity was last modified, in ISO 8601 format (for example, 2024-01-15T12:34:56Z). |
| Azure.Storage.EntitiesNextToken | String | The continuation token to retrieve the next page of entities. Empty when there are no more results. |
azure-storage-table-create#
Creates a new table in a storage account. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/write.
Base Command#
azure-storage-table-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table to create. Must be alphanumeric, start with a letter, and be 3 to 63 characters long. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Table.TableName | String | The name of the created table. |
azure-storage-table-delete#
Deletes the specified table and any data it contains. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/delete.
Base Command#
azure-storage-table-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table to delete. | Required |
Context Output#
There is no context output for this command.
azure-storage-tables-list#
Lists tables under the specified storage account. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/read.
Base Command#
azure-storage-tables-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| limit | The maximum number of tables to return. Accepted values are 1 to 1000. Default is 50. Default is 50. | Optional |
| filter | The OData query expression used to filter the returned tables. | Optional |
| next_token | The continuation token returned by a previous call (Azure.Storage.TablesNextToken), used to retrieve the next page of results. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Table.TableName | String | The name of the table. |
| Azure.Storage.TablesNextToken | String | The continuation token to retrieve the next page of tables. Empty when there are no more results. |
azure-storage-table-entity-insert#
Inserts a new entity into a table. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/entities/write.
Base Command#
azure-storage-table-entity-insert
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table into which to insert the entity. | Required |
| partition_key | The PartitionKey property of the entity which is the unique identifier for the partition within a given table. | Required |
| row_key | The RowKey property of the entity, which is the unique identifier for an entity within a given partition. | Required |
| entity_fields | A JSON object of the entity's fields and their values, for example, {"Age": 20}. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Table.Entity.PartitionKey | String | The PartitionKey property of the entity. |
| Azure.Storage.Table.Entity.RowKey | String | The RowKey property of the entity. |
| Azure.Storage.Table.Entity.Timestamp | Date | The date and time the entity was last modified, in ISO 8601 format (for example, 2024-01-15T12:34:56Z). |
azure-storage-table-entity-update#
Updates an existing entity in a table by merging the provided properties. Does not replace the existing entity. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/entities/write.
Base Command#
azure-storage-table-entity-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table containing the entity. | Required |
| partition_key | The PartitionKey property of the entity to update. | Required |
| row_key | The RowKey property of the entity to update. | Required |
| entity_fields | A JSON object of the entity's fields and their values to merge, for example, {"Address": "New York"}. | Required |
Context Output#
There is no context output for this command.
azure-storage-table-entity-replace#
Replaces an existing entity in a table. Replaces the entire entity and can be used to remove properties. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/entities/write.
Base Command#
azure-storage-table-entity-replace
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table containing the entity. | Required |
| partition_key | The PartitionKey property of the entity to replace. | Required |
| row_key | The RowKey property of the entity to replace. | Required |
| entity_fields | A JSON object of the entity's fields and their values. Replaces the entire entity, for example, {"Address": "New York"}. | Required |
Context Output#
There is no context output for this command.
azure-storage-table-entity-delete#
Deletes an existing entity in a table. Required permission: Microsoft.Storage/storageAccounts/tableServices/tables/entities/delete.
Base Command#
azure-storage-table-entity-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| account_name | The name of the storage account. | Required |
| table_name | The name of the table containing the entity. | Required |
| partition_key | The PartitionKey property of the entity to delete. | Required |
| row_key | The RowKey property of the entity to delete. | Required |
Context Output#
There is no context output for this command.
azure-vn-ip-group-create#
Creates an IP group resource and polls until the IP group is fully provisioned. Required permissions: Microsoft.Network/ipGroups/write, Microsoft.Network/ipGroups/read.
Base Command#
azure-vn-ip-group-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| ip_group_name | The name of the IP group to create. | Required |
| location | The Azure region in which to create the IP group. | Required |
| ip_addresses | A comma-separated list of IP addresses or IP address prefixes to include in the IP group (for example, "10.0.0.1,10.1.0.0/24"). | Optional |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.IPGroups.id | String | The IP group resource ID. |
| Azure.VirtualNetworks.IPGroups.name | String | The name of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.type | String | The resource type. |
| Azure.VirtualNetworks.IPGroups.location | String | The resource location. |
| Azure.VirtualNetworks.IPGroups.etag | String | The ETag of the IP group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.IPGroups.tags | Unknown | A dictionary of the tags assigned to the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.provisioningState | String | The provisioning state of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.properties.ipAddresses | Unknown | A list of the IP addresses or IP address prefixes in the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewalls | Unknown | A list of references to the firewalls that use the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewallPolicies | Unknown | A list of references to the firewall policies that use the IP group. |
azure-vn-ip-group-update#
Updates an IP group resource by adding or removing IP addresses and polls until the IP group is fully provisioned. Required permissions: Microsoft.Network/ipGroups/read, Microsoft.Network/ipGroups/write.
Base Command#
azure-vn-ip-group-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| ip_group_name | The name of the IP group to update. | Required |
| ip_addresses_to_add | A comma-separated list of IP addresses or IP address prefixes to add to the IP group (for example, "10.0.0.1,10.1.0.0/24"). It is mandatory to provide ip_addresses_to_add, ip_addresses_to_remove, or both. | Optional |
| ip_addresses_to_remove | A comma-separated list of IP addresses or IP address prefixes to remove from the IP group (for example, "10.0.0.1,10.1.0.0/24"). Addresses that are not in the IP group are ignored. It is mandatory to provide ip_addresses_to_add, ip_addresses_to_remove, or both. | Optional |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.IPGroups.id | String | The IP group resource ID. |
| Azure.VirtualNetworks.IPGroups.name | String | The name of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.type | String | The resource type. |
| Azure.VirtualNetworks.IPGroups.location | String | The resource location. |
| Azure.VirtualNetworks.IPGroups.etag | String | The ETag of the IP group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.IPGroups.tags | Unknown | A dictionary of the tags assigned to the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.provisioningState | String | The provisioning state of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.properties.ipAddresses | Unknown | A list of the IP addresses or IP address prefixes in the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewalls | Unknown | A list of references to the firewalls that use the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewallPolicies | Unknown | A list of references to the firewall policies that use the IP group. |
azure-vn-ip-group-get#
Retrieves an IP group resource. Required permissions: Microsoft.Network/ipGroups/read.
Base Command#
azure-vn-ip-group-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| ip_group_name | The name of the IP group to retrieve. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.IPGroups.id | String | The IP group resource ID. |
| Azure.VirtualNetworks.IPGroups.name | String | The name of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.type | String | The resource type. |
| Azure.VirtualNetworks.IPGroups.location | String | The resource location. |
| Azure.VirtualNetworks.IPGroups.etag | String | The ETag of the IP group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.IPGroups.tags | Unknown | A dictionary of the tags assigned to the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.provisioningState | String | The provisioning state of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.properties.ipAddresses | Unknown | A list of the IP addresses or IP address prefixes in the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewalls | Unknown | A list of references to the firewalls that use the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewallPolicies | Unknown | A list of references to the firewall policies that use the IP group. |
azure-vn-ip-groups-list#
Lists the IP groups in a resource group, or in the subscription when no resource group is provided. Use the next_token argument to view the next page of results. Required permissions: Microsoft.Network/ipGroups/read.
Base Command#
azure-vn-ip-groups-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. When not provided, the IP groups are listed for the entire subscription. | Optional |
| next_token | The token for retrieving the next page of results. Use the Azure.VirtualNetworks.IPGroupsNextToken value from the previous response. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.IPGroups.id | String | The IP group resource ID. |
| Azure.VirtualNetworks.IPGroups.name | String | The name of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.type | String | The resource type. |
| Azure.VirtualNetworks.IPGroups.location | String | The resource location. |
| Azure.VirtualNetworks.IPGroups.etag | String | The ETag of the IP group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.IPGroups.tags | Unknown | A dictionary of the tags assigned to the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.provisioningState | String | The provisioning state of the IP group resource. |
| Azure.VirtualNetworks.IPGroups.properties.ipAddresses | Unknown | A list of the IP addresses or IP address prefixes in the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewalls | Unknown | A list of references to the firewalls that use the IP group. |
| Azure.VirtualNetworks.IPGroups.properties.firewallPolicies | Unknown | A list of references to the firewall policies that use the IP group. |
| Azure.VirtualNetworks.IPGroupsNextToken | String | The URI to use when requesting the next set of IP groups. |
azure-vn-ip-group-delete#
Deletes an IP group resource. Required permissions: Microsoft.Network/ipGroups/delete.
Base Command#
azure-vn-ip-group-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| ip_group_name | The name of the IP group to delete. | Required |
Context Output#
There is no context output for this command.
azure-firewall-list#
Lists the Azure firewalls in the specified resource group or subscription. Use the next_token argument to view the next page of results. Required permission: Microsoft.Network/azureFirewalls/read.
Base Command#
azure-firewall-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Required when the resource argument is set to resource_group, and ignored when it is set to subscription. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource | The scope that contains the firewalls to list. Possible values are: resource_group, subscription. Default is resource_group. | Optional |
| next_token | The token for the next set of items to return, used for pagination. The token is the value of Azure.Firewall.FirewallsNextToken from the previous response. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.id | String | The ID of the firewall resource. |
| Azure.Firewall.Firewalls.name | String | The name of the firewall resource. |
| Azure.Firewall.Firewalls.type | String | The type of the firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the firewall resource. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the firewall, used to prevent overwriting concurrent updates. |
| Azure.Firewall.Firewalls.tags | Unknown | The tags of the firewall resource. |
| Azure.Firewall.Firewalls.zones | Unknown | The availability zones of the firewall. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the firewall resource. |
| Azure.Firewall.Firewalls.properties.threatIntelMode | String | The operation mode for threat intelligence. |
| Azure.Firewall.Firewalls.properties.ipConfigurations | Unknown | The IP configuration objects of the firewall, containing the id, name, etag, type, and properties fields. |
| Azure.Firewall.Firewalls.properties.firewallPolicy | Unknown | The firewall policy associated with the firewall, containing the id field. |
| Azure.Firewall.Firewalls.properties.sku | Unknown | The SKU of the firewall, containing the name and tier fields. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the firewall, containing the id, name, etag, and properties fields. |
| Azure.Firewall.Firewalls.properties.applicationRuleCollections | Unknown | The application rule collections of the firewall, containing the id, name, etag, and properties fields. |
| Azure.Firewall.Firewalls.properties.natRuleCollections | Unknown | The NAT rule collections of the firewall, containing the id, name, etag, and properties fields. |
| Azure.Firewall.Firewalls.properties.managementIpConfiguration | Unknown | The management IP configuration of the firewall, containing the name, id, etag, type, and properties fields. |
| Azure.Firewall.Firewalls.properties.hubIPAddresses | Unknown | The IP addresses associated with the firewall, containing the publicIPs and privateIPAddress fields. |
| Azure.Firewall.Firewalls.properties.ipGroups | Unknown | The IP groups associated with the firewall, containing the id and changeNumber fields. |
| Azure.Firewall.Firewalls.properties.virtualHub | Unknown | The virtual hub to which the firewall belongs, containing the id field. |
| Azure.Firewall.Firewalls.properties.autoscaleConfiguration | Unknown | The autoscale configuration of the firewall, containing the minCapacity and maxCapacity fields. |
| Azure.Firewall.Firewalls.properties.additionalProperties | Unknown | The additional properties used to further configure the firewall. |
| Azure.Firewall.Firewalls.properties.afcConfiguration | Unknown | The Azure Firewall Cloud configuration of the firewall, containing the serviceEndpoint field. |
| Azure.Firewall.Firewalls.extendedLocation | Unknown | The extended location of the firewall, containing the name and type fields. |
| Azure.Firewall.Firewalls.extendedLocation.name | String | The name of the extended location. |
| Azure.Firewall.Firewalls.extendedLocation.type | String | The type of the extended location. |
| Azure.Firewall.FirewallsNextToken | String | The URI used to fetch the next page of firewalls. Run the same command with the next_token argument to get the next page of firewalls. |
azure-firewall-get#
Gets the properties of an Azure firewall, and displays its rule collections when a rule type is specified. Required permission: Microsoft.Network/azureFirewalls/read.
Base Command#
azure-firewall-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure firewall to retrieve. | Required |
| rule_type | The rule collection type to display for the firewall. When omitted, the rule collections are not displayed. Possible values are: application_rule, network_rule, nat_rule. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.id | String | The ID of the firewall resource. |
| Azure.Firewall.Firewalls.name | String | The name of the firewall resource. |
| Azure.Firewall.Firewalls.type | String | The type of the firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the firewall resource. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the firewall, used to prevent overwriting concurrent updates. |
| Azure.Firewall.Firewalls.tags | Unknown | The tags of the firewall resource. |
| Azure.Firewall.Firewalls.zones | Unknown | The availability zones of the firewall. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the firewall resource. |
| Azure.Firewall.Firewalls.properties.threatIntelMode | String | The operation mode for threat intelligence. |
| Azure.Firewall.Firewalls.properties.ipConfigurations | Unknown | The IP configuration objects of the firewall, containing the id, name, etag, type, and properties fields. |
| Azure.Firewall.Firewalls.properties.firewallPolicy | Unknown | The firewall policy associated with the firewall, containing the id field. |
| Azure.Firewall.Firewalls.properties.sku | Unknown | The SKU of the firewall, containing the name and tier fields. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the firewall, containing the id, name, etag, and properties fields. |
| Azure.Firewall.Firewalls.properties.applicationRuleCollections | Unknown | The application rule collections of the firewall, containing the id, name, etag, and properties fields. |
| Azure.Firewall.Firewalls.properties.natRuleCollections | Unknown | The NAT rule collections of the firewall, containing the id, name, etag, and properties fields. |
| Azure.Firewall.Firewalls.properties.managementIpConfiguration | Unknown | The management IP configuration of the firewall, containing the name, id, etag, type, and properties fields. |
| Azure.Firewall.Firewalls.properties.hubIPAddresses | Unknown | The IP addresses associated with the firewall, containing the publicIPs and privateIPAddress fields. |
| Azure.Firewall.Firewalls.properties.ipGroups | Unknown | The IP groups associated with the firewall, containing the id and changeNumber fields. |
| Azure.Firewall.Firewalls.properties.virtualHub | Unknown | The virtual hub to which the firewall belongs, containing the id field. |
| Azure.Firewall.Firewalls.properties.autoscaleConfiguration | Unknown | The autoscale configuration of the firewall, containing the minCapacity and maxCapacity fields. |
| Azure.Firewall.Firewalls.properties.additionalProperties | Unknown | The additional properties used to further configure the firewall. |
| Azure.Firewall.Firewalls.properties.afcConfiguration | Unknown | The Azure Firewall Cloud configuration of the firewall, containing the serviceEndpoint field. |
| Azure.Firewall.Firewalls.extendedLocation | Unknown | The extended location of the firewall, containing the name and type fields. |
| Azure.Firewall.Firewalls.extendedLocation.name | String | The name of the extended location. |
| Azure.Firewall.Firewalls.extendedLocation.type | String | The type of the extended location. |
azure-firewall-rules-list#
Lists the rules of an Azure firewall rule collection or a firewall policy rule collection group. It is mandatory to provide either the firewall_name or policy_name argument. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/read.
Base Command#
azure-firewall-rules-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure firewall that contains the rules. It is mandatory to provide either firewall_name or policy_name. | Optional |
| policy_name | The name of the Azure firewall policy that contains the rules. It is mandatory to provide either firewall_name or policy_name. | Optional |
| rule_type | The rule type to retrieve. Required when the firewall_name argument is provided. Possible values are: application_rule, network_rule, nat_rule. | Optional |
| collection_name | The name of the rule collection that contains the rules. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Rules.name | String | The name of the rule. |
| Azure.Firewall.Rules.description | String | The description of the rule. |
| Azure.Firewall.Rules.ruleType | String | The type of the rule. |
| Azure.Firewall.Rules.protocols | Unknown | The protocols of the rule. |
| Azure.Firewall.Rules.sourceAddresses | Unknown | The source addresses of the rule. |
| Azure.Firewall.Rules.destinationAddresses | Unknown | The destination addresses of the rule. |
| Azure.Firewall.Rules.destinationPorts | Unknown | The destination ports of the rule. |
| Azure.Firewall.Rules.sourceIpGroups | Unknown | The source IP groups of the rule. |
| Azure.Firewall.Rules.destinationIpGroups | Unknown | The destination IP groups of the rule. |
| Azure.Firewall.Rules.destinationFqdns | Unknown | The destination FQDNs of the rule. |
| Azure.Firewall.Rules.targetFqdns | Unknown | The target FQDNs of the rule. |
| Azure.Firewall.Rules.targetUrls | Unknown | The target URLs of the application rule. |
| Azure.Firewall.Rules.fqdnTags | Unknown | The FQDN tags of the application rule. |
| Azure.Firewall.Rules.webCategories | Unknown | The web categories of the application rule. |
| Azure.Firewall.Rules.terminateTLS | Boolean | Whether the TLS connection is terminated for the application rule. |
| Azure.Firewall.Rules.ipProtocols | Unknown | The IP protocols of the NAT rule. |
| Azure.Firewall.Rules.translatedAddress | String | The translated address of the NAT rule. |
| Azure.Firewall.Rules.translatedPort | String | The translated port of the NAT rule. |
| Azure.Firewall.Rules.translatedFqdn | String | The translated FQDN of the NAT rule. |
azure-firewall-rule-get#
Gets the properties of an Azure firewall or firewall policy rule. It is mandatory to provide either the firewall_name or policy_name argument. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/read.
Base Command#
azure-firewall-rule-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure firewall that contains the rule. It is mandatory to provide either firewall_name or policy_name argument. | Optional |
| policy_name | The name of the Azure firewall policy that contains the rule. It is mandatory to provide either firewall_name or policy_name argument. | Optional |
| rule_type | The rule type to retrieve. Required when the firewall_name argument is provided. Possible values are: application_rule, network_rule, nat_rule. | Optional |
| collection_name | The name of the rule collection that contains the rule. | Required |
| rule_name | The name of the rule to retrieve. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Rules.name | String | The name of the rule. |
| Azure.Firewall.Rules.description | String | The description of the rule. |
| Azure.Firewall.Rules.ruleType | String | The type of the rule. |
| Azure.Firewall.Rules.protocols | Unknown | The protocols of the rule. |
| Azure.Firewall.Rules.sourceAddresses | Unknown | The source addresses of the rule. |
| Azure.Firewall.Rules.destinationAddresses | Unknown | The destination addresses of the rule. |
| Azure.Firewall.Rules.destinationPorts | Unknown | The destination ports of the rule. |
| Azure.Firewall.Rules.sourceIpGroups | Unknown | The source IP groups of the rule. |
| Azure.Firewall.Rules.destinationIpGroups | Unknown | The destination IP groups of the rule. |
| Azure.Firewall.Rules.destinationFqdns | Unknown | The destination FQDNs of the rule. |
| Azure.Firewall.Rules.targetFqdns | Unknown | The target FQDNs of the rule. |
| Azure.Firewall.Rules.targetUrls | Unknown | The target URLs of the application rule. |
| Azure.Firewall.Rules.fqdnTags | Unknown | The FQDN tags of the application rule. |
| Azure.Firewall.Rules.webCategories | Unknown | The web categories of the application rule. |
| Azure.Firewall.Rules.terminateTLS | Boolean | Whether the TLS connection is terminated for the application rule. |
| Azure.Firewall.Rules.ipProtocols | Unknown | The IP protocols of the NAT rule. |
| Azure.Firewall.Rules.translatedAddress | String | The translated address of the NAT rule. |
| Azure.Firewall.Rules.translatedPort | String | The translated port of the NAT rule. |
| Azure.Firewall.Rules.translatedFqdn | String | The translated FQDN of the NAT rule. |
azure-firewall-service-tags-information-list#
Lists the service tag information resources of a specified location. Use the next_token argument to view the next page of results. Required permission: Microsoft.Network/locations/serviceTagDetails/read.
Base Command#
azure-firewall-service-tags-information-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| location | The location that is used as a reference for the service tags version. For example, eastus. | Required |
| next_token | The token for the next set of items to return, used for pagination. The token is the value of Azure.VirtualNetworks.ServiceTagsInformationNextToken from the previous response. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.ServiceTagsInformation.id | String | The ID of the service tag. |
| Azure.VirtualNetworks.ServiceTagsInformation.name | String | The name of the service tag. |
| Azure.VirtualNetworks.ServiceTagsInformation.serviceTagChangeNumber | String | The iteration number of the service tag object. |
| Azure.VirtualNetworks.ServiceTagsInformation.properties.changeNumber | String | The iteration number of the service tag properties. |
| Azure.VirtualNetworks.ServiceTagsInformation.properties.region | String | The region of the service tag. |
| Azure.VirtualNetworks.ServiceTagsInformation.properties.systemService | String | The system service of the service tag. |
| Azure.VirtualNetworks.ServiceTagsInformation.properties.addressPrefixes | Unknown | The list of IP address prefixes of the service tag. |
| Azure.VirtualNetworks.ServiceTagsInformation.properties.state | String | The state of the service tag. |
| Azure.VirtualNetworks.ServiceTagsInformation.properties.networkFeatures | Unknown | The network features of the service tag, indicating where the service tag is applicable. |
| Azure.VirtualNetworks.ServiceTagsInformationNextToken | String | The URI used to fetch the next page of service tags. Run the same command with the next_token argument to get the next page of service tags. |
azure-vn-firewall-policy-rule-collection-groups-list#
Lists the rule collection groups of an Azure firewall policy. Required permission: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read.
Base Command#
azure-vn-firewall-policy-rule-collection-groups-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the Azure firewall policy that contains the rule collection groups. | Required |
| rule_type | The rule collection type to retrieve. Possible values are: application_rule, network_rule, nat_rule. | Required |
| next_token | The token for the next set of items to return, used for pagination. The token is the value of Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroupsNextToken from the previous response. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.id | String | The ID of the rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.name | String | The name of the rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.type | String | The type of the rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.etag | String | The ETag of the rule collection group, used to prevent overwriting concurrent updates. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.location | String | The location of the rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.priority | Number | The priority of the rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.provisioningState | String | The provisioning state of the rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.ruleCollections | Unknown | The rule collections of the policy rule collection group, containing the ruleCollectionType, name, priority, action, and rules fields. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.size | String | The size of the rule collection group in kilobytes. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroupsNextToken | String | The URI used to fetch the next page of rule collection groups. Run the same command with the next_token argument to get the next page of rule collection groups. |
azure-storage-containers-list#
Lists containers under the specified storage account. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/read.
Base Command#
azure-storage-containers-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| account_name | The name of the storage account. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| prefix | The prefix used to filter results to return only containers whose names begin with the specified value. | Optional |
| limit | The maximum number of containers to retrieve. Accepted range is 1 to 5000. Default is 50. | Optional |
| next_token | The continuation token returned by a previous call (Azure.Storage.ContainersNextToken), used to retrieve the next page of results. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Container.name | String | The container name. |
| Azure.Storage.Container.Property.Last-Modified | Date | The date and time the container was last modified, in RFC 1123 format (for example, Wed, 14 Aug 2024 10:00:00 GMT). |
| Azure.Storage.Container.Property.Etag | String | The entity tag for the container. |
| Azure.Storage.Container.Property.LeaseStatus | String | The lease status of the container. |
| Azure.Storage.Container.Property.LeaseState | String | The lease state of the container. |
| Azure.Storage.ContainersNextToken | String | The continuation token to use when requesting the next set of containers. |
azure-storage-blobs-list#
Lists blobs under the specified container. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read.
Base Command#
azure-storage-blobs-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the container. | Required |
| account_name | The name of the storage account. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| prefix | The prefix used to filter results to return only blobs whose names begin with the specified value. | Optional |
| limit | The maximum number of blobs to retrieve. Accepted range is 1 to 5000. Default is 50. | Optional |
| next_token | The continuation token returned by a previous call (Azure.Storage.BlobsNextToken), used to retrieve the next page of results. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Blob.name | String | The name of the blob. |
| Azure.Storage.Blob.ContainerName | String | The name of the container that holds the blob. |
| Azure.Storage.Blob.Property | Unknown | The blob system properties, including: Last-Modified, Etag, Content-Length, Content-Type, Content-Encoding, Content-Language, Content-MD5, Cache-Control, Content-Disposition, BlobType, LeaseStatus, LeaseState, and ServerEncrypted. |
| Azure.Storage.BlobsNextToken | String | The continuation token to use when requesting the next set of blobs. |
azure-storage-blob-update#
Updates the content of an existing blob. Fails if the blob does not exist. Required permissions: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read, Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write.
Base Command#
azure-storage-blob-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the container. | Required |
| file_entry_id | The entry ID of the file to upload as the blob content. Available from the War Room when the context data contains file output. | Required |
| blob_name | The name of the blob to update. | Required |
| account_name | The name of the storage account. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
Context Output#
There is no context output for this command.
azure-storage-blob-delete#
Marks a specific blob for deletion. The blob is deleted during garbage collection. Required permission: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/delete.
Base Command#
azure-storage-blob-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the container. | Required |
| blob_name | The name of the blob to delete. | Required |
| account_name | The name of the storage account. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
Context Output#
There is no context output for this command.
azure-storage-container-sas-create#
Creates a shared access signature (SAS) token for a container.
Base Command#
azure-storage-container-sas-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| container_name | The name of the container. | Required |
| account_name | The name of the storage account. | Required |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| expiry_time | The expiry time for the SAS token, in hours. Default is 1. | Required |
| signed_resources | The resources that are accessible via the shared access signature. Can be "c" (container), "b" (blob), "bv" (blob version), "bs" (blob snapshot), or "d" (directory). Possible values are: c, b, bv, bs, d. Default is c. | Required |
| signed_permissions | The permissions that are associated with the shared access signature. The user is restricted to operations that are allowed by the permissions. Possible permissions: r = Read, a = Add, c = Create, w = Write. The permissions must follow this order "racwdxltmeop". For example: r, c, a, w, rac, racw. Default is r. | Required |
| signed_ip | The public IP address or range of public IP addresses from which to accept requests. | Optional |
| account_key | The access key of the storage account, used to sign the SAS token. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Storage.Container.SAS.name | String | The name of the container. |
| Azure.Storage.Container.SAS.SASURL | String | The generated SAS URL for the container. |
azure-rg-list-operations#
Gets all Azure Resource Graph operations permissions and descriptions. Required permission: Microsoft.ResourceGraph/operations/read.
Base Command#
azure-rg-list-operations
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ResourceGraph.Operations.Name | String | The name of the Azure Resource Graph operation. |
| Azure.ResourceGraph.Operations.Display | Unknown | The display information of the Azure Resource Graph operation, including provider, resource, operation, and description. |
azure-rg-query#
Executes an Azure Resource Graph query based on Kusto Query Language (KQL). For example: query="Resources | project name, type | limit 5 | order by name asc". Required permission: Microsoft.ResourceGraph/resources/read.
Base Command#
azure-rg-query
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| query | The query for the Azure Resource Graph to execute. For example: resources \| where (resourceGroup =~ ('demisto-sentinel2')).The query is based on Kusto Query Language (KQL). Reference: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/. | Required |
| limit | The maximum number of resources to return. Accepted values are 1 to 1000. Note: Do not use with page and page_size. Default is 50. | Optional |
| page_size | The maximum number of resources to return per page. Accepted values are 1 to 1000. | Optional |
| page | The page number to return. | Optional |
| management_groups | A comma-separated list of Azure management groups against which to execute the query. For example: 'mg1, mg2'. | Optional |
| subscriptions | A comma-separated list of Azure subscriptions against which to execute the query. For example: 'sub1, sub2'. | Optional |
| next_token | The token for the next set of results to return, used for pagination. Retrieved from the Azure.ResourceGraph.QueryNextToken output of a previous run. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ResourceGraph.Query.id | String | The resource ID of the resource returned by the query. |
| Azure.ResourceGraph.Query.name | String | The name of the resource returned by the query. |
| Azure.ResourceGraph.Query.type | String | The type of the resource returned by the query. |
| Azure.ResourceGraph.Query.location | String | The location of the resource returned by the query. |
| Azure.ResourceGraph.Query.tags | Unknown | The tags of the resource returned by the query. |
| Azure.ResourceGraph.QueryNextToken | String | The token to pass as the next_token argument to retrieve the next set of query results. |
azure-vn-virtual-networks-list#
Gets virtual networks in a resource group. Required permissions: Microsoft.Network/virtualNetworks/read.
Base Command#
azure-vn-virtual-networks-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| next_token | The URI to fetch the next page of results as returned in the Azure.VirtualNetworks.VirtualNetworksNextToken output of a previous run. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.VirtualNetworksNextToken | String | The URI to fetch the next page of virtual networks. Run the same command with the next_token argument to get the next page. |
| Azure.VirtualNetworks.VirtualNetworks.name | String | The virtual network's name. |
| Azure.VirtualNetworks.VirtualNetworks.id | String | The virtual network's ID. |
| Azure.VirtualNetworks.VirtualNetworks.etag | String | The virtual network's ETag. |
| Azure.VirtualNetworks.VirtualNetworks.type | String | The resource type. |
| Azure.VirtualNetworks.VirtualNetworks.location | String | The virtual network's location. |
| Azure.VirtualNetworks.VirtualNetworks.tags | Unknown | The tags associated with the virtual network. |
| Azure.VirtualNetworks.VirtualNetworks.properties.provisioningState | String | The provisioning state of the virtual network resource. Possible values are Succeeded, Updating, Deleting, or Failed. |
| Azure.VirtualNetworks.VirtualNetworks.properties.resourceGuid | String | The resource GUID property of the virtual network resource. |
| Azure.VirtualNetworks.VirtualNetworks.properties.addressSpace | Unknown | The address space object of the virtual network. Contains the addressPrefixes field, which is a list of address blocks reserved for this virtual network in CIDR notation. |
| Azure.VirtualNetworks.VirtualNetworks.properties.subnets | Unknown | The list of subnets in the virtual network. Each subnet contains the name, ID, and properties fields. |
| Azure.VirtualNetworks.VirtualNetworks.properties.virtualNetworkPeerings | Unknown | The list of peerings in the virtual network. |
| Azure.VirtualNetworks.VirtualNetworks.properties.dhcpOptions | Unknown | The dhcpOptions object of the virtual network. Contains the dnsServers field, which is a list of DNS servers IP addresses. |
| Azure.VirtualNetworks.VirtualNetworks.properties.enableDdosProtection | Boolean | Whether DDoS protection is enabled for all the protected resources in the virtual network. |
azure-rm-subscriptions-list#
Gets all subscriptions for a tenant. Required permissions: Microsoft.Resources/subscriptions/read.
Base Command#
azure-rm-subscriptions-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID used to authenticate the request. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| next_token | The URI to fetch the next page of results as returned in the Azure.ResourceManagement.SubscriptionsNextToken output of a previous run. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.ResourceManagement.SubscriptionsNextToken | String | The URI to fetch the next page of subscriptions. Run the same command with the next_token argument to get the next page. |
| Azure.ResourceManagement.Subscriptions.id | String | The unique identifier of the subscription. |
| Azure.ResourceManagement.Subscriptions.subscriptionId | String | The ID of the subscription. |
| Azure.ResourceManagement.Subscriptions.tenantId | String | The ID of the tenant associated with the subscription. |
| Azure.ResourceManagement.Subscriptions.displayName | String | The display name of the subscription. |
| Azure.ResourceManagement.Subscriptions.state | String | The current state of the subscription. Possible values are Enabled, Warned, PastDue, Disabled, or Deleted. |
| Azure.ResourceManagement.Subscriptions.authorizationSource | String | The authorization source of the request. Possible values are Legacy, RoleBased, Bypassed, Direct, or Management. |
| Azure.ResourceManagement.Subscriptions.managedByTenants | Unknown | The list of tenants that have access to manage the subscription. |
| Azure.ResourceManagement.Subscriptions.tags | Unknown | The tags associated with the subscription. |
| Azure.ResourceManagement.Subscriptions.subscriptionPolicies.locationPlacementId | String | The ID of the location placement policy for the subscription. |
| Azure.ResourceManagement.Subscriptions.subscriptionPolicies.quotaId | String | The ID of the quota policy for the subscription. |
| Azure.ResourceManagement.Subscriptions.subscriptionPolicies.spendingLimit | String | The spending limit policy for the subscription. |
azure-firewall-rule-collection-groups-create#
Creates a network rule collection that contains a single network rule in an Azure Firewall. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-rule-collection-groups-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure Firewall in which to create the network rule collection. | Required |
| collection_name | The name of the network rule collection to create. | Required |
| collection_priority | The priority of the network rule collection. Must be between 100 and 65000. | Required |
| action | The action type of the network rule collection. Possible values are: Allow, Deny. | Required |
| rule_name | The name of the network rule to create in the collection. | Required |
| description | The description of the created network rule. | Optional |
| protocols | A comma-separated list of protocols for the created network rule. Possible values are: TCP, UDP, ICMP, Any. | Required |
| source_type | The source type of the created network rule. Possible values are: ip_address, ip_group. | Required |
| source_ips | A comma-separated list of source IP addresses for the created network rule. Required when source_type is ip_address. | Optional |
| source_ip_group_ids | A comma-separated list of source IP group IDs for the created network rule. Required when source_type is ip_group. | Optional |
| destination_type | The destination type of the created network rule. Possible values are: ip_address, ip_group, service_tag, fqdn. | Required |
| destinations | A comma-separated list of destinations for the created network rule. Must match the value of destination_type. Supports IP addresses, IP group IDs, service tag names, and FQDNs. | Required |
| destination_ports | A comma-separated list of destination ports for the created network rule. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.name | String | The name of the Azure Firewall. |
| Azure.Firewall.Firewalls.id | String | The ID of the Azure Firewall. |
| Azure.Firewall.Firewalls.type | String | The type of the Azure Firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the Azure Firewall. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the Azure Firewall. The ETag prevents concurrent updates from overwriting each other. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the Azure Firewall. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the Azure Firewall, containing the name, etag, id, and properties fields of each collection. |
azure-firewall-rule-collection-groups-update#
Updates the priority or the action of a network rule collection in an Azure Firewall. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-rule-collection-groups-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure Firewall that contains the network rule collection. | Required |
| collection_name | The name of the network rule collection to update. | Required |
| priority | The new priority of the network rule collection. Must be between 100 and 65000. It is mandatory to provide priority, action, or both. | Optional |
| action | The new action type of the network rule collection. It is mandatory to provide priority, action, or both. Possible values are: Allow, Deny. | Optional |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.name | String | The name of the Azure Firewall. |
| Azure.Firewall.Firewalls.id | String | The ID of the Azure Firewall. |
| Azure.Firewall.Firewalls.type | String | The type of the Azure Firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the Azure Firewall. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the Azure Firewall. The ETag prevents concurrent updates from overwriting each other. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the Azure Firewall. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the Azure Firewall, containing the name, etag, id, and properties fields of each collection. |
azure-firewall-rule-collection-groups-delete#
Deletes a network rule collection from an Azure Firewall. Required permissions: Microsoft.Network/azureFirewalls/read, Microsoft.Network/azureFirewalls/write.
Base Command#
azure-firewall-rule-collection-groups-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| firewall_name | The name of the Azure Firewall that contains the network rule collection. | Required |
| collection_name | The name of the network rule collection to delete. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.Firewall.Firewalls.name | String | The name of the Azure Firewall. |
| Azure.Firewall.Firewalls.id | String | The ID of the Azure Firewall. |
| Azure.Firewall.Firewalls.type | String | The type of the Azure Firewall resource. |
| Azure.Firewall.Firewalls.location | String | The location of the Azure Firewall. |
| Azure.Firewall.Firewalls.etag | String | The ETag of the Azure Firewall. The ETag prevents concurrent updates from overwriting each other. |
| Azure.Firewall.Firewalls.properties.provisioningState | String | The provisioning state of the Azure Firewall. |
| Azure.Firewall.Firewalls.properties.networkRuleCollections | Unknown | The network rule collections of the Azure Firewall, containing the name, etag, id, and properties fields of each collection. |
azure-vn-firewall-policy-network-rule-create#
Creates a network rule in an existing network rule collection of a firewall policy rule collection group. Required permissions: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/write.
Base Command#
azure-vn-firewall-policy-network-rule-create
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the firewall policy that contains the rule collection group. | Required |
| collection_name | The name of the network rule collection in which to create the network rule. | Required |
| rule_name | The name of the network rule to create. | Required |
| description | The description of the created network rule. | Optional |
| protocols | A comma-separated list of protocols for the created network rule. Possible values are: TCP, UDP, ICMP, Any. | Required |
| source_type | The source type of the created network rule. Possible values are: ip_address, ip_group. | Required |
| source_ips | A comma-separated list of source IP addresses for the created network rule. Required when source_type is ip_address. | Optional |
| source_ip_group_ids | A comma-separated list of source IP group IDs for the created network rule. Required when source_type is ip_group. | Optional |
| destination_type | The destination type of the created network rule. Possible values are: ip_address, ip_group, service_tag, fqdn. | Required |
| destinations | A comma-separated list of destinations for the created network rule. Must match the value of destination_type. Supports IP addresses, IP group IDs, service tag names, and FQDNs. | Required |
| destination_ports | A comma-separated list of destination ports for the created network rule. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.name | String | The name of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.id | String | The ID of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.type | String | The type of the firewall policy rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.etag | String | The ETag of the firewall policy rule collection group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.priority | Number | The priority of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.provisioningState | String | The provisioning state of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.ruleCollections | Unknown | The rule collections of the group, containing the ruleCollectionType, name, priority, action, and rules fields of each collection. |
azure-vn-firewall-policy-network-rule-update#
Updates a network rule in a network rule collection of a firewall policy rule collection group. Only the provided properties are replaced. The rest of the rule configuration remains unchanged. Required permissions: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/write.
Base Command#
azure-vn-firewall-policy-network-rule-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the firewall policy that contains the rule collection group. | Required |
| collection_name | The name of the network rule collection that contains the network rule. | Required |
| rule_name | The name of the network rule to update. | Required |
| description | The new description of the network rule. | Optional |
| protocols | A comma-separated list of protocols that replaces the protocols of the network rule. Possible values are: TCP, UDP, ICMP, Any. | Optional |
| source_type | The new source type of the network rule. If provided, you must also provide source_ips or source_ip_group_ids. Possible values are: ip_address, ip_group. | Optional |
| source_ips | A comma-separated list of source IP addresses that replaces the sources of the network rule. Required when source_type is ip_address. | Optional |
| source_ip_group_ids | A comma-separated list of source IP group IDs that replaces the sources of the network rule. Required when source_type is ip_group. | Optional |
| destination_type | The new destination type of the network rule. Required when destinations is provided. Possible values are: ip_address, ip_group, service_tag, fqdn. | Optional |
| destinations | A comma-separated list of destinations that replaces the destinations of the network rule. Must match the value of destination_type. Supports IP addresses, IP group IDs, service tag names, and FQDNs. | Optional |
| destination_ports | A comma-separated list of destination ports that replaces the destination ports of the network rule. | Optional |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.name | String | The name of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.id | String | The ID of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.type | String | The type of the firewall policy rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.etag | String | The ETag of the firewall policy rule collection group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.priority | Number | The priority of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.provisioningState | String | The provisioning state of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.ruleCollections | Unknown | The rule collections of the group, containing the ruleCollectionType, name, priority, action, and rules fields of each collection. |
azure-vn-firewall-policy-network-rule-delete#
Deletes network rules from a network rule collection of a firewall policy rule collection group. Required permissions: Microsoft.Network/firewallPolicies/ruleCollectionGroups/read, Microsoft.Network/firewallPolicies/ruleCollectionGroups/write.
Base Command#
azure-vn-firewall-policy-network-rule-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. | Required |
| policy_name | The name of the firewall policy that contains the rule collection group. | Required |
| collection_name | The name of the network rule collection that contains the network rules. | Required |
| rule_names | A comma-separated list of network rule names to delete from the collection. | Required |
| interval_in_seconds | The interval, in seconds, between polling attempts. Must be a positive number. Default is 30. | Optional |
| polling_timeout | The time, in seconds, after which polling stops. Must be a positive number. Default is 600. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.name | String | The name of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.id | String | The ID of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.type | String | The type of the firewall policy rule collection group resource. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.etag | String | The ETag of the firewall policy rule collection group. The ETag prevents concurrent updates from overwriting each other. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.priority | Number | The priority of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.provisioningState | String | The provisioning state of the firewall policy rule collection group. |
| Azure.VirtualNetworks.FirewallPolicyRuleCollectionGroups.properties.ruleCollections | Unknown | The rule collections of the group, containing the ruleCollectionType, name, priority, action, and rules fields of each collection. |
azure-log-analytics-saved-searches-list#
Gets the saved searches of a Log Analytics workspace. Required permission: Microsoft.OperationalInsights/workspaces/savedSearches/read.
Base Command#
azure-log-analytics-saved-searches-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.LogAnalytics.SavedSearches.id | String | The fully qualified resource ID for the resource. |
| Azure.LogAnalytics.SavedSearches.name | String | The name of the resource. |
| Azure.LogAnalytics.SavedSearches.etag | String | The ETag of the saved search. |
| Azure.LogAnalytics.SavedSearches.type | String | The resource type. |
| Azure.LogAnalytics.SavedSearches.properties.category | String | The category of the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.displayName | String | The display name of the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.functionAlias | String | The function alias if the query serves as a function. |
| Azure.LogAnalytics.SavedSearches.properties.functionParameters | String | The optional function parameters if the query serves as a function. |
| Azure.LogAnalytics.SavedSearches.properties.query | String | The query expression for the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.tags | Unknown | The tags attached to the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.version | Number | The version number of the query language. |
| Azure.LogAnalytics.SavedSearches.systemData | Unknown | The Azure Resource Manager metadata containing createdBy and modifiedBy information. |
azure-log-analytics-saved-search-get#
Gets a specified saved search from a Log Analytics workspace. Required permission: Microsoft.OperationalInsights/workspaces/savedSearches/read.
Base Command#
azure-log-analytics-saved-search-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| saved_search_id | The ID of the saved search. | Required |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.LogAnalytics.SavedSearches.id | String | The fully qualified resource ID for the resource. |
| Azure.LogAnalytics.SavedSearches.name | String | The name of the resource. |
| Azure.LogAnalytics.SavedSearches.etag | String | The ETag of the saved search. |
| Azure.LogAnalytics.SavedSearches.type | String | The resource type. |
| Azure.LogAnalytics.SavedSearches.properties.category | String | The category of the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.displayName | String | The display name of the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.functionAlias | String | The function alias if the query serves as a function. |
| Azure.LogAnalytics.SavedSearches.properties.functionParameters | String | The optional function parameters if the query serves as a function. |
| Azure.LogAnalytics.SavedSearches.properties.query | String | The query expression for the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.tags | Unknown | The tags attached to the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.version | Number | The version number of the query language. |
| Azure.LogAnalytics.SavedSearches.systemData | Unknown | The Azure Resource Manager metadata containing createdBy and modifiedBy information. |
azure-log-analytics-saved-search-create-update#
Creates or updates a saved search in a Log Analytics workspace. Required permissions: Microsoft.OperationalInsights/workspaces/savedSearches/read, Microsoft.OperationalInsights/workspaces/savedSearches/write.
Base Command#
azure-log-analytics-saved-search-create-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| saved_search_id | The ID of the saved search. | Required |
| etag | The ETag of the saved search. This argument is required for updating an existing saved search. | Optional |
| category | The category of the saved search. | Required |
| display_name | The display name of the saved search. | Required |
| function_alias | The function alias if the query serves as a function. | Optional |
| function_parameters | The optional function parameters if the query serves as a function. The value should be in the following format: param-name1:type1 = default_value1, param-name2:type2 = default_value2. | Optional |
| query | The query expression for the saved search. | Required |
| tags | The tags attached to the saved search. The value should be in the following format: name=value;name=value. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.LogAnalytics.SavedSearches.id | String | The fully qualified resource ID for the resource. |
| Azure.LogAnalytics.SavedSearches.name | String | The name of the resource. |
| Azure.LogAnalytics.SavedSearches.etag | String | The ETag of the saved search. |
| Azure.LogAnalytics.SavedSearches.type | String | The resource type. |
| Azure.LogAnalytics.SavedSearches.properties.category | String | The category of the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.displayName | String | The display name of the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.functionAlias | String | The function alias if the query serves as a function. |
| Azure.LogAnalytics.SavedSearches.properties.functionParameters | String | The optional function parameters if the query serves as a function. |
| Azure.LogAnalytics.SavedSearches.properties.query | String | The query expression for the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.tags | Unknown | The tags attached to the saved search. |
| Azure.LogAnalytics.SavedSearches.properties.version | Number | The version number of the query language. |
| Azure.LogAnalytics.SavedSearches.systemData | Unknown | The Azure Resource Manager metadata containing createdBy and modifiedBy information. |
azure-log-analytics-saved-search-delete#
Deletes a specified saved search in a Log Analytics workspace. Required permission: Microsoft.OperationalInsights/workspaces/savedSearches/delete.
Base Command#
azure-log-analytics-saved-search-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| saved_search_id | The ID of the saved search. | Required |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
There is no context output for this command.
azure-log-analytics-workspaces-list#
Gets Log Analytics workspaces in a resource group. Required permission: Microsoft.OperationalInsights/workspaces/read.
Base Command#
azure-log-analytics-workspaces-list
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0 and Cortex Cloud). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.LogAnalytics.Workspaces.id | String | The fully qualified resource ID for the resource. |
| Azure.LogAnalytics.Workspaces.name | String | The name of the resource. |
| Azure.LogAnalytics.Workspaces.type | String | The resource type. |
| Azure.LogAnalytics.Workspaces.location | String | The geo-location where the resource lives. |
| Azure.LogAnalytics.Workspaces.etag | String | The ETag of the workspace. |
| Azure.LogAnalytics.Workspaces.identity | Unknown | The identity of the resource. |
| Azure.LogAnalytics.Workspaces.tags | Unknown | The resource tags. |
| Azure.LogAnalytics.Workspaces.properties.createdDate | Date | The date and time when the workspace was created in ISO 8601 format (for example, 2024-01-15T12:34:56Z). |
| Azure.LogAnalytics.Workspaces.properties.customerId | String | The ID associated with the workspace. |
| Azure.LogAnalytics.Workspaces.properties.defaultDataCollectionRuleResourceId | String | The resource ID of the default data collection rule to use for this workspace. |
| Azure.LogAnalytics.Workspaces.properties.failover | Unknown | The workspace failover properties. |
| Azure.LogAnalytics.Workspaces.properties.features | Unknown | The workspace features. |
| Azure.LogAnalytics.Workspaces.properties.forceCmkForQuery | Boolean | Whether customer managed storage is mandatory for query management. |
| Azure.LogAnalytics.Workspaces.properties.modifiedDate | Date | The date and time when the workspace was modified in ISO 8601 format (for example, 2024-01-15T12:34:56Z). |
| Azure.LogAnalytics.Workspaces.properties.privateLinkScopedResources | Unknown | The list of linked private link scope resources. |
| Azure.LogAnalytics.Workspaces.properties.provisioningState | String | The provisioning state of the workspace. |
| Azure.LogAnalytics.Workspaces.properties.publicNetworkAccessForIngestion | String | The network access type for accessing Log Analytics ingestion. |
| Azure.LogAnalytics.Workspaces.properties.publicNetworkAccessForQuery | String | The network access type for accessing Log Analytics query. |
| Azure.LogAnalytics.Workspaces.properties.replication | Unknown | Workspace replication properties. |
| Azure.LogAnalytics.Workspaces.properties.retentionInDays | Number | The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. |
| Azure.LogAnalytics.Workspaces.properties.sku | Unknown | The SKU of the workspace. |
| Azure.LogAnalytics.Workspaces.properties.workspaceCapping | Unknown | The daily volume cap for ingestion. |
| Azure.LogAnalytics.Workspaces.systemData | Unknown | The Azure Resource Manager metadata containing createdBy and modifiedBy information. |
azure-log-analytics-table-get#
Gets a Log Analytics workspace table (search job). Required permission: Microsoft.OperationalInsights/workspaces/tables/read.
Base Command#
azure-log-analytics-table-get
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| table_name | The name of the table. Example value: AuditLogs_SRCH. | Required |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.LogAnalytics.Tables.id | String | The fully qualified resource ID for the resource. |
| Azure.LogAnalytics.Tables.name | String | The name of the resource. |
| Azure.LogAnalytics.Tables.type | String | The resource type. |
| Azure.LogAnalytics.Tables.properties.archiveRetentionInDays | Number | The table's long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays). |
| Azure.LogAnalytics.Tables.properties.lastPlanModifiedDate | String | The date and time when the table plan was last modified (UTC) in ISO 8601 format (for example, 2024-01-15T12:34:56Z). |
| Azure.LogAnalytics.Tables.properties.plan | String | The instruction for the system on how to handle and charge the logs ingested into this table. |
| Azure.LogAnalytics.Tables.properties.protectionLevel | String | The protection level of the table. Determines the default data access isolation behavior. |
| Azure.LogAnalytics.Tables.properties.provisioningState | String | The table's current provisioning state. If set to updating, it indicates a resource lock due to an ongoing operation, forbidding any update to the table until the ongoing operation is concluded. |
| Azure.LogAnalytics.Tables.properties.restoredLogs | Unknown | The parameters of the restore operation that created the table. |
| Azure.LogAnalytics.Tables.properties.resultStatistics | Unknown | The search job execution statistics. |
| Azure.LogAnalytics.Tables.properties.retentionInDays | Number | The table's analytics retention in days for Analytics tables, between 4 and 730. Setting this property to -1 defaults to the workspace retention. For Basic and Auxiliary tables, this is a read-only property. |
| Azure.LogAnalytics.Tables.properties.retentionInDaysAsDefault | Boolean | Whether the value originates from workspace retention in days (true) or is customer specific (false). |
| Azure.LogAnalytics.Tables.properties.schema | Unknown | The table schema. |
| Azure.LogAnalytics.Tables.properties.searchResults | Unknown | The parameters of the search job that initiated the table. |
| Azure.LogAnalytics.Tables.properties.totalRetentionInDays | Number | The table's total retention in days, between 4 and 4383. Setting this property to -1 defaults to retentionInDays. |
| Azure.LogAnalytics.Tables.properties.totalRetentionInDaysAsDefault | Boolean | Whether the value originates from retention in days (true) or is customer specific (false). |
| Azure.LogAnalytics.Tables.systemData | Unknown | The Azure Resource Manager metadata containing createdBy and modifiedBy information. |
azure-log-analytics-table-run#
Runs a search job to fetch records from large datasets into a new search results table in the workspace, and polls until the table is provisioned. Required permissions: Microsoft.OperationalInsights/workspaces/tables/read, Microsoft.OperationalInsights/workspaces/tables/write, Microsoft.OperationalInsights/workspaces/searchJobs/write.
Base Command#
azure-log-analytics-table-run
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| table_name | The name of the table to add. Must contain the _SRCH suffix. For example, AuditLogs_SRCH. | Required |
| limit | The maximum number of records to return in the result set. Default is 50. | Optional |
| query | The log query written in KQL format to retrieve data. Search job queries must start with a table name. | Required |
| start_search_time | The start of the time range to search. The value can be in minutes, days, weeks, or ISO 8601 format (for example, 2023-10-31T00:00:00Z). Default is 1 day. | Optional |
| end_search_time | The end of the time range to search. The value can be in minutes, days, weeks, or ISO 8601 format (for example, 2023-10-31T00:00:00Z). Default is now. | Optional |
| timeout | The timeout in seconds until polling ends. Default is 600. | Optional |
| interval | The interval in seconds between each poll. Default is 60. | Optional |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| Azure.LogAnalytics.Tables.TableName | String | The table name. |
| Azure.LogAnalytics.Tables.Query | String | The query that was used to create the table. |
azure-log-analytics-table-delete#
Deletes a Log Analytics workspace table (search job). Required permission: Microsoft.OperationalInsights/workspaces/tables/delete.
Base Command#
azure-log-analytics-table-delete
Input#
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >=3.0, Cortex Cloud and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| table_name | The name of the table. Must contain the _SRCH suffix. For example, AuditLogs_SRCH. | Required |
| resource_group_name | The name of the resource group. Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| workspace_name | The name of the Log Analytics workspace. | Required |
Context Output#
There is no context output for this command.
azure-postgres-flexible-server-configuration-update#
Updates the configuration of a PostgreSQL Flexible Server. Required permissions: Microsoft.DBforPostgreSQL/flexibleServers/configurations/write.
Base Command#
azure-postgres-flexible-server-configuration-update
Input#
| Argument Name | Description | Required |
|---|---|---|
| resource_group_name | The name of the resource group. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| subscription_id | The Azure subscription ID. Required for Cortex Platform (which includes Cortex XSIAM version >= 3.0, Cortex Cloud, and Cortex Agentix). Optional for Cortex XSOAR and Cortex XSIAM version < 3.0, where it can be retrieved from the integration configuration. | Optional |
| server_name | The name of the PostgreSQL Flexible Server. | Required |
| configuration_name | The name of the server configuration parameter to update. | Required |
| source | The source of the configuration value (for example, user-override). | Optional |
| value | The new value of the configuration, which is also known as a server parameter. Required for updating the value assigned to a specific modifiable configuration. | Required |
Context Output#
There is no context output for this command.