ApiKeys interface
Gränssnitt som representerar en ApiKeys.
Metoder
| create |
Skapa eller uppdatera en API-nyckel för Nginx-distributionen för att få åtkomst till API-slutpunkten för dataplanet |
| delete(string, string, string, Api |
Ta bort API-nyckel för Nginx-distribution |
| get(string, string, string, Api |
Hämta den angivna API-nyckeln för den givna Nginx-distributionen |
| list(string, string, Api |
Visa en lista över alla API-nycklar för den givna Nginx-distributionen |
Metodinformation
createOrUpdate(string, string, string, ApiKeysCreateOrUpdateOptionalParams)
Skapa eller uppdatera en API-nyckel för Nginx-distributionen för att få åtkomst till API-slutpunkten för dataplanet
function createOrUpdate(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysCreateOrUpdateOptionalParams): Promise<NginxDeploymentApiKeyResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- deploymentName
-
string
Namnet på den riktade NGINX-distributionen
- apiKeyName
-
string
Resursnamnet för API-nyckeln
Alternativparametrarna.
Returer
Promise<NginxDeploymentApiKeyResponse>
delete(string, string, string, ApiKeysDeleteOptionalParams)
Ta bort API-nyckel för Nginx-distribution
function delete(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- deploymentName
-
string
Namnet på den riktade NGINX-distributionen
- apiKeyName
-
string
Resursnamnet för API-nyckeln
- options
- ApiKeysDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, ApiKeysGetOptionalParams)
Hämta den angivna API-nyckeln för den givna Nginx-distributionen
function get(resourceGroupName: string, deploymentName: string, apiKeyName: string, options?: ApiKeysGetOptionalParams): Promise<NginxDeploymentApiKeyResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- deploymentName
-
string
Namnet på den riktade NGINX-distributionen
- apiKeyName
-
string
Resursnamnet för API-nyckeln
- options
- ApiKeysGetOptionalParams
Alternativparametrarna.
Returer
Promise<NginxDeploymentApiKeyResponse>
list(string, string, ApiKeysListOptionalParams)
Visa en lista över alla API-nycklar för den givna Nginx-distributionen
function list(resourceGroupName: string, deploymentName: string, options?: ApiKeysListOptionalParams): PagedAsyncIterableIterator<NginxDeploymentApiKeyResponse, NginxDeploymentApiKeyResponse[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- deploymentName
-
string
Namnet på den riktade NGINX-distributionen
- options
- ApiKeysListOptionalParams
Alternativparametrarna.
