Inputs & Outputs
AzureClient
-
Contains Azure authentication details using a service principal
-
It is used as an input to many of the actions in this plugin
Generating API Access Keys
See this Azure article for information about creating a service principal.
Supplying Credentials
You should always use a PPA Vault integration to provide credentials to a plugin action.
Required Keys
tenant_id: Azure Tenant ID
client_id: Azure Client ID
client_secret: Azure Client Secret
Example
1 2 3 4 |
|
Group
- Contains information about an Azure AD Group
AD Group Keys
description: The group description
display_name: Group display name (not unique)
mail_enabled: Indicates whether the group is mail enabled
object_id: Group object ID
object_type: The type of the object (Group
)
security_enabled: Indicates whether the group is security enabled
ResourceGroup
- Contains information about an Azure Resource Group
ResourceGroup Keys
name: Resource name
location: Resource location
tags: Dictionary of tags
SecurityGroup
- Contains information about an Azure Network Security Group
SecurityGroup Keys
id: Resource ID (including Resource Group)
name: Resource name
location: Resource location
tags: Dictionary of tags
SecurityGroupRule
- Contains information about an Azure Network Security Group rule
SecurityGroupRule Keys
Name: Rule name
description: Rule description
protocol: Protocol (tcp
, udp
, or *
for any)
direction: Direction (inbound
or outbound
)
access: Access (allow
or deny
)
priority: Rules are processed in priority order; the lower the number, the higher the priority.
source_port_range: Source port range
source_address_prefix: Source address
source_address_prefixes: Source addresses (if multiple)
destination_port_range: Destination port range
destination_address_prefix: Destination address
destination_address_prefixes: Destination addresses (if multiple)
User
- Contains information about an Azure AD User
AD User Keys
account_enabled: Denotes whether the user is enabled
display_name: User display name (not unique)
given_name: The user's given name
mail: User email address
mail_nickname: User email alias
object_id: User object ID
object_type: The type of the object (User
)
user_principal_name: User principal name
surname: The user's surname
usage_location: A two letter country code (ISO standard 3166)
VirtualMachine
- Contains information about an Azure Virtual Machine instance
VirtualMachine Keys
id: Resource ID (including Resource Group)
name: Resource name
type: Resource type
location: Resource location
tags: Dictionary of tags
vm_id: VM unique ID