Azure Actions
Overview
The Microsoft Azure Actions page details the range of operations that can be performed through the Azure integration within Rewst. Organized by categories, it provides specific actions for managing accounts, blob containers, key vaults, storage accounts, virtual machines, and virtual networks.
Account
List Subscriptions
List all subscriptions for the current account
Subscription Request
GET subscriptions
Key | Type | Description |
---|---|---|
api-version | String (?) | None Provided |
List Resource Groups
List all resource groups for the current account
Resource Groups Request
GET {subscription_id}/resourcegroups
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
api-version | String (?) | None Provided |
Blob Containers
List Blob Storage Containers
Retrieves a list of blob storage containers in the specified Azure subscription.
Containers Request
GET {storage_account}/blobServices/default/containers
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the storage account/blob storage |
storage_account* | Microsoft Azure Storage Account | The Azure Storage Account to use |
api-version | String (?) | None Provided |
Get Blob Storage Container
Retrieves a blob storage container in the specified storage account.
Blob Storage Request
GET {blobStorageId}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The name of the resource group that contains the storage accounts |
storage_account* | Microsoft Azure Storage Account | The Storage account the blob storage is in |
blobStorageId* | Microsoft Azure Blob Storage | The Blob Storage to reference |
api-version | String (?) | None Provided |
Delete Blob Storage Container
Deletes a blob storage container in the specified storage account.
Blob Storage Container Request
DELETE {blobStorageId}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The name of the resource group that contains the storage accounts |
storage_account* | Microsoft Azure Storage Account | The Storage account the blob storage is in |
blobStorageId* | Microsoft Azure Blob Storage | The Blob Storage to reference |
api-version | String (?) | None Provided |
Create Blob Storage Container
Creates a BlobStorage Container in the specified resource group.
Create Blob Storage Container Request
PUT {storage_account}/blobServices/default/containers/{container_name}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The name of the resource group that contains the storage accounts |
storage_account* | Microsoft Azure Storage Account | The Storage account the blob storage is in |
container_name* | String (?) | The name of the new blob storage |
api-version | String (?) | None Provided |
Blob Container Objects
Blob Container Object Properties
Key | Type | Description |
---|---|---|
publicAccess | String (?) | None Provided |
defaultEncryptionScope | String (?) | Default the container to use specified encryption scope for all writes. |
denyEncryptionScopeOverride | String (?) | Block override of encryption scope from the container default. |
enableNfsV3AllSquash | String (?) | Enable NFSv3 all squash on blob container? |
enableNfsV3RootSquash | String (?) | Enable NFSv3 root squash on blob container? |
Key Vaults
List Key Vaults
Retrieves a list of Key Vaults in a specified resource group
List Key Vaults Request
GET {resource_group}/providers/Microsoft.KeyVault/vaults
Key | Type | Description |
---|---|---|
subscription_id* | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the key vaults |
api-version | String (?) | None Provided |
Get Key Vault
Gets a specified Key Vault from a resource group
Get Key Vault Request
GET {vaultID}
Key | Type | Description |
---|---|---|
subscription_id* | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the key vault |
vaultID* | Microsoft Azure Key Vault | The Azure key vault to reference. |
api-version | String (?) | None Provided |
Delete Key Vault
Deletes a specified Key Vault in a resource group
Delete Key Vault Request
DELETE {vaultID}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the key vault |
vaultID* | Microsoft Azure Key Vault | The Azure key vault to reference. |
api-version | String (?) | None Provided |
Create Key Vault
Creates a new Key Vault in a specified resource group
Create Key Vault Request
PUT {resource_group}/providers/Microsoft.KeyVault/vaults/{keyVaultName}
Key | Type | Description |
---|---|---|
subscription_id* | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the key vaults. |
keyVaultName* | String (?) | None Provided |
api-version | String (?) | None Provided |
location* | String | The Azure Region to use |
List Keys In Key Vault
Lists Keys in a specified Key Vault
List Keys In Key Vault Request
GET {vault_base_url}keys
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The Azure Resource Group |
vault_base_url* | Microsoft Azure Key Vault | The Azure key vault to reference. |
api-version | String (?) | None Provided |
Create Key In Key Vault
Creates a new Key in a specified Key Vault
Create Key In Key Vault Request
POST {vault_base_url}keys/{keyName}/create
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The Azure Resource Group |
vault_base_url* | Microsoft Azure Key Vault | The Azure key vault to reference. |
keyName* | String (?) | None Provided |
api-version | String (?) | None Provided |
kty* | String (?) | None Provided |
crv | String (?) | None Provided |
public_exponent | String (?) | The public exponent for a RSA key. This applies only to keys created in a Managed HSM. |
key_size* | String (?) | None Provided |
key_ops | String (?) | None Provided |
tags | String (?) | Tags to assign to the key |
Delete Key In Key Vault
Deletes a Key in a specified Key Vault
Delete Key In Key Vault Request
DELETE {key_id}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The Azure Resource Group |
vault_base_url* | Microsoft Azure Key Vault | The Azure key vault to reference. |
key_id* | Microsoft Azure Key Name | The key to reference in the key vault |
api-version | String (?) | None Provided |
Key Vault Objects
Key Vault Object Properties
Key | Type | Description |
---|---|---|
tenantId* | Microsoft Azure Tenant | The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. |
enablePurgeProtection | String (?) | Property specifying whether protection against purge is enabled for this vault.Setting this property to true activates protection against purge for this vault and its content;only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective onlyif soft delete is also enabled. Enabling this functionality is irreversible - that is, the propertydoes not accept false as its value. |
enableRbacAuthorization | String (?) | Property that controls how data actions are authorized.When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, andthe access policies specified in vault properties will be ignored. When false, the key vault will use theaccess policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored.If null or not specified, the vault is created with the default value of false.Note that management actions are always authorized with RBAC. |
enableSoftDelete | String (?) | Property to specify whether the 'soft delete' functionality is enabled for this key vault.If it's not set to any value(true or false) when creating new key vault, it will be set to true by default.Once set to true, it cannot be reverted to false. |
enabledForDeployment | String (?) | Property to specify whether Azure Virtual Machines are permitted to retrieve certificatesstored as secrets from the key vault. |
enabledForDiskEncryption | String (?) | Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault andunwrap keys. |
enabledForTemplateDeployment | String (?) | Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. |
publicNetworkAccess | String (?) | None Provided |
Releasepolicy
Key | Type | Description |
---|---|---|
contentType | String (?) | None Provided |
data | String (?) | Blob encoding the policy rules under which the key can be released. Blob must be base64 URL encoded. |
immutable | String (?) | Defines the mutability state of the policy. Once marked immutable, this flag cannot be reset and thepolicy cannot be changed under any circumstances. |
Sku
Key | Type | Description |
---|---|---|
family | String (?) | None Provided |
name | String (?) | None Provided |
Accesspolicy
Key | Type | Description |
---|---|---|
tenantId* | Microsoft Azure Access Tenant | The tenant to use |
objectId* | String (?) | The object to assign the permissions to.By default this field can accept an Application, User, or Group ID. |
Networkacl
Key | Type | Description |
---|---|---|
bypass | String (?) | None Provided |
defaultAction | String (?) | None Provided |
Permission
Key | Type | Description |
---|---|---|
keys | String (?) | None Provided |
secrets | String (?) | None Provided |
certificates | String (?) | None Provided |
Iprule
Key | Type | Description |
---|---|---|
value | String (?) | An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address)or '124.56.78.0/24' (all addresses that start with 124.56.78). |
Virtualnetworkrule
Key | Type | Description |
---|---|---|
id | Microsoft Azure Virtual Network | The Azure Virtual Network you want to use |
ignoreMissingVnetServiceEndpoint | String (?) | Property to specify whether NRP will ignore the check if parent subnet hasserviceEndpoints configured. |
Storage Accounts
List Storage Accounts
Retrieves a list of storage accounts in the specified Azure subscription.
List Storage Accounts Request
GET {resource_group}/providers/Microsoft.Storage/storageAccounts
Key | Type | Description |
---|---|---|
subscription_id* | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the storage account. |
api-version | String (?) | None Provided |
Get Storage Account
Retrieves a specific storage account
Get Storage Account Request
GET {storageAccountId}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The name of the resource group that contains the storage accounts |
storageAccountId* | Microsoft Azure Storage Account | The Azure Storage Account to use |
api-version | String (?) | None Provided |
Delete Storage Account
Deletes a storage account
Delete Storage Account Request
DELETE {storageAccountId}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group | Microsoft Azure Resource Group | The name of the resource group that contains the storage accounts |
storageAccountId* | Microsoft Azure Storage Account | The Azure Storage Account to use |
api-version | String (?) | None Provided |
Create Storage Account
Creates a storage account
Create Storage Account Request
PUT {resource_group}/providers/Microsoft.Storage/storageAccounts/{storage_account}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the storage accounts |
storage_account* | String (?) | None Provided |
api-version | String (?) | None Provided |
kind* | String (?) | None Provided |
location* | String | The Azure Region to use |
Storage Account Objects
Storage Account Object Sku
Key | Type | Description |
---|---|---|
name* | String (?) | The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
tier* | String (?) | The SKU tier. This is based on the SKU name. |
Property
Key | Type | Description |
---|---|---|
accessTier | String (?) | Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. |
allowBlobPublicAccess | String (?) | Allow or disallow public access to all blobs or containers in the storage account. |
allowCrossTenantReplication | String (?) | Allow or disallow cross AAD tenant object replication. |
allowSharedKeyAccess | String (?) | Indicates 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. |
allowedCopyScope | String (?) | None Provided |
publicNetworkAccess | String (?) | None Provided |
tags | String (?) | Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. |
Virtual Machines
List Virtual Machines
Retrieves a list of virtual machines in the specified Azure subscription.
List Virtual Machines Request
GET {resource_group}/providers/Microsoft.Compute/virtualMachines
Key | Type | Description |
---|---|---|
subscription_id* | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual machines. |
api-version | String (?) | None Provided |
Delete Virtual Machine
Deletes a virtual machine in the specified Azure subscription.
Delete Virtual Machine Request
DELETE {virtual_machine_id}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual machines. |
virtual_machine_id* | Microsoft Azure Virtual Machine | The Virtual Machine to use |
api-version | String (?) | None Provided |
Get Virtual Machine
Retrieves information on a virtual machine in the specified Azure subscription.
Get Virtual Machine Request
GET {virtual_machine_id}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual machines. |
virtual_machine_id* | Microsoft Azure Virtual Machine | The Virtual Machine to use |
api-version | String (?) | None Provided |
Create Virtual Machine
Creates a new Virtual Machine in the specified resource group
Create Virtual Machine Request
PUT {resource_group}/providers/Microsoft.Compute/virtualMachines/{vm_name}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group in which to create the virtual machine |
vm_name* | String (?) | None Provided |
api-version | String (?) | None Provided |
location* | String | The location in which to create the virtual machine |
Virtual Machines Object Properties
Networkprofile
Hardwareprofile
Key | Type | Description |
---|---|---|
vmSize | Microsoft Azure Size of the Virtual Machine | The size of the virtual machine to create |
Storageprofile
Osprofile
Key | Type | Description |
---|---|---|
computerName* | String (?) | The computer name for the virtual machine |
adminUsername* | String (?) | The admin username for the virtual machine |
adminPassword* | String (?) | The admin password for the virtual machine |
Networkinterfacestoattach
Key | Type | Description |
---|---|---|
id | Microsoft Azure Network Interface | The Network Interface to use |
Image
Key | Type | Description |
---|---|---|
publisher | String (?) | The publisher of the virtual machine image to use |
offer | String (?) | The offer of the virtual machine image to use |
sku | String (?) | The SKU of the virtual machine image to use |
version | String (?) | The version of the virtual machine image to use |
Osdisk
Key | Type | Description |
---|---|---|
name* | String (?) | The name of the OS disk to create |
diskSizeGB | String (?) | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. |
osType | String (?) | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. |
caching | String (?) | The caching mode for the OS disk |
createOption* | String (?) | None Provided |
Manageddisk
Key | Type | Description |
---|---|---|
storageAccountType* | String (?) | None Provided |
Virtual Networks
List Virtual Networks
Retrieves a list of virtual networks in the specified resource group.
Request
GET {resource_group}/providers/Microsoft.Network/virtualNetworks
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual networks. |
api-version | String (?) | None Provided |
Delete Virtual Network
Deletes a specified virtual network in a resource group.
Delete Virtual Network Request
DELETE {virtual_network}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual network. |
virtual_network* | Microsoft Azure Virtual Network | The Azure Virtual Network you want to use |
api-version | String (?) | None Provided |
Get Virtual Network
Retrieves a specified virtual network in a resource group.
Get Virtual Network Request
GET {virtual_network}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual network. |
virtual_network* | Microsoft Azure Virtual Network | The Azure Virtual Network you want to use |
api-version | String (?) | None Provided |
Create Virtual Network
Creates a new virtual network in a specified resource group.
Create Virtual Network Request
PUT {resource_group}/providers/Microsoft.Network/virtualNetworks/{virtual_network_name}
Key | Type | Description |
---|---|---|
subscription_id | Microsoft Azure Subscription | The Azure subscription to Use. |
resource_group* | Microsoft Azure Resource Group | The name of the resource group that contains the virtual network. |
virtual_network_name* | String (?) | None Provided |
api-version | String (?) | None Provided |
location* | String | The Azure Region to use |
Virtual Network Objects
Virtual Network Object Properties
Key | Type | Description |
---|---|---|
enableDdosProtection | String (?) | None Provided |
enableVmProtection | String (?) | Indicates if VM protection is enabled for all the subnets in the virtual network. |
Addressspace
Key | Type | Description |
---|---|---|
addressPrefixes | Array | The AddressSpace that contains an array of IP address ranges that can be used by subnets. |
Dhcpoption
Key | Type | Description |
---|---|---|
dnsServers | Array | The list of DNS servers IP addresses. |
Ddosprotectionplan
Key | Type | Description |
---|---|---|
id | Microsoft Azure DDoS Protection Plan | None Provided |
Subnet
Key | Type | Description |
---|---|---|
name* | String (?) | None Provided |
Address Prefix Property
Key | Type | Description |
---|---|---|
addressPrefix | String (?) | None Provided |
Delegation
Key | Type | Description |
---|---|---|
name | String (?) | None Provided |
Last updated