ApiKeys interface
表示 ApiKeys 的接口。
方法
| create |
为 Nginx 部署创建或更新 API 密钥，以便访问数据平面 API 端点 |
| delete(string, string, string, Api |
删除 Nginx 部署的 API 密钥 |
| get(string, string, string, Api |
获取给定 Nginx 部署的指定 API 密钥 |
| list(string, string, Api |
列出给定 Nginx 部署的所有 API 密钥 |
方法详细信息
createOrUpdate(string, string, string, ApiKeysCreateOrUpdateOptionalParams)
为 Nginx 部署创建或更新 API 密钥，以便访问数据平面 API 端点
function createOrUpdate(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysCreateOrUpdateOptionalParams): Promise<NginxDeploymentApiKeyResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- deploymentName
-
string
目标 NGINX 部署的名称
- apiKeyName
-
string
API 密钥的资源名称
选项参数。
返回
Promise<NginxDeploymentApiKeyResponse>
delete(string, string, string, ApiKeysDeleteOptionalParams)
删除 Nginx 部署的 API 密钥
function delete(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- deploymentName
-
string
目标 NGINX 部署的名称
- apiKeyName
-
string
API 密钥的资源名称
- options
- ApiKeysDeleteOptionalParams
选项参数。
返回
Promise<void>
get(string, string, string, ApiKeysGetOptionalParams)
获取给定 Nginx 部署的指定 API 密钥
function get(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysGetOptionalParams): Promise<NginxDeploymentApiKeyResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- deploymentName
-
string
目标 NGINX 部署的名称
- apiKeyName
-
string
API 密钥的资源名称
- options
- ApiKeysGetOptionalParams
选项参数。
返回
Promise<NginxDeploymentApiKeyResponse>
list(string, string, ApiKeysListOptionalParams)
列出给定 Nginx 部署的所有 API 密钥
function list(resourceGroupName: string, deploymentName: string, options?: ApiKeysListOptionalParams): PagedAsyncIterableIterator<NginxDeploymentApiKeyResponse, NginxDeploymentApiKeyResponse[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- deploymentName
-
string
目标 NGINX 部署的名称
- options
- ApiKeysListOptionalParams
选项参数。
