ApiKeys interface
Interface representing a ApiKeys.
Methods
| create |
Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint |
| delete(string, string, string, Api |
Delete API key for Nginx deployment |
| get(string, string, string, Api |
Get the specified API Key of the given Nginx deployment |
| list(string, string, Api |
List all API Keys of the given Nginx deployment |
Method Details
createOrUpdate(string, string, string, ApiKeysCreateOrUpdateOptionalParams)
Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint
function createOrUpdate(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysCreateOrUpdateOptionalParams): Promise<NginxDeploymentApiKeyResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- apiKeyName
-
string
The resource name of the API key
The options parameters.
Returns
Promise<NginxDeploymentApiKeyResponse>
delete(string, string, string, ApiKeysDeleteOptionalParams)
Delete API key for Nginx deployment
function delete(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- apiKeyName
-
string
The resource name of the API key
- options
- ApiKeysDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ApiKeysGetOptionalParams)
Get the specified API Key of the given Nginx deployment
function get(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysGetOptionalParams): Promise<NginxDeploymentApiKeyResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- apiKeyName
-
string
The resource name of the API key
- options
- ApiKeysGetOptionalParams
The options parameters.
Returns
Promise<NginxDeploymentApiKeyResponse>
list(string, string, ApiKeysListOptionalParams)
List all API Keys of the given Nginx deployment
function list(resourceGroupName: string, deploymentName: string, options?: ApiKeysListOptionalParams): PagedAsyncIterableIterator<NginxDeploymentApiKeyResponse, NginxDeploymentApiKeyResponse[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- options
- ApiKeysListOptionalParams
The options parameters.
