Share via


ApiKeysOperations interface

Interface representing a ApiKeys operations.

Properties

createOrUpdate

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint

delete
get

Get the specified API Key of the given Nginx deployment

list

List all API Keys of the given Nginx deployment

Property Details

createOrUpdate

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint

createOrUpdate: (resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysCreateOrUpdateOptionalParams) => Promise<NginxDeploymentApiKeyResponse>

Property Value

(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysCreateOrUpdateOptionalParams) => Promise<NginxDeploymentApiKeyResponse>

delete

delete: (resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysDeleteOptionalParams) => Promise<void>

get

Get the specified API Key of the given Nginx deployment

get: (resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysGetOptionalParams) => Promise<NginxDeploymentApiKeyResponse>

Property Value

(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysGetOptionalParams) => Promise<NginxDeploymentApiKeyResponse>

list

List all API Keys of the given Nginx deployment

list: (resourceGroupName: string, deploymentName: string, options?: ApiKeysListOptionalParams) => PagedAsyncIterableIterator<NginxDeploymentApiKeyResponse, NginxDeploymentApiKeyResponse[], PageSettings>

Property Value

(resourceGroupName: string, deploymentName: string, options?: ApiKeysListOptionalParams) => PagedAsyncIterableIterator<NginxDeploymentApiKeyResponse, NginxDeploymentApiKeyResponse[], PageSettings>