Skip to content

azurekeyvault

Configuration for Azure Key Vault entity resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name for the Key Vault. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the Key Vault is created.



CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my keyvault" or 'my keyvault').

Minimum length = 1
azurevaultname <String> Read-write Name of the Key Vault configured in Azure cloud using either the Azure CLI or the Azure portal (GUI).

Minimum length = 3

Maximum length = 25
azureapplication <String> Read-write Name of the Azure Application object created on the ADC appliance. This object will be used for authentication with Azure Active Directory.

Minimum length = 1

Maximum length = 63
state <String> Read-only Current state of keyvault.

Possible values = Created, Could not reach token endpoint, Authorization failed, Token parse error, Access token obtained, Keyvault host is reachable, Keyvault operation succeeded, Keyvault operation failed, Ops failed. Keyvault marked down
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • COUNT

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"azurekeyvault":{
<b>      "name":<String_value>,
</b>      "azurevaultname":<String_value>,
<b>      "azureapplication":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of azurekeyvault resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault? view=summary

Use this query-parameter to get the summary output of azurekeyvault resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault? pagesize=#no;pageno=#no

Use this query-parameter to get the azurekeyvault resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "azurekeyvault": [ {
      "name":<String_value>,
      "azurevaultname":<String_value>,
      "azureapplication":<String_value>,
      "state":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of azurekeyvault resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "azurekeyvault": [ {
      "name":<String_value>,
      "azurevaultname":<String_value>,
      "azureapplication":<String_value>,
      "state":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/azurekeyvault? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "azurekeyvault": [ { "__count": "#no"} ] }