JWTAuthenticators interface

Package:

@azure/arm-containerservice

Interface representing a JWTAuthenticators.

Methods

beginCreateOrUpdate(string, string, string, JWTAuthenticator, JWTAuthenticatorsCreateOrUpdateOptionalParams)	Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.
beginCreateOrUpdateAndWait(string, string, string, JWTAuthenticator, JWTAuthenticatorsCreateOrUpdateOptionalParams)	Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.
beginDelete(string, string, string, JWTAuthenticatorsDeleteOptionalParams)	Deletes a JWT authenticator and updates the managed cluster to apply the settings.
beginDeleteAndWait(string, string, string, JWTAuthenticatorsDeleteOptionalParams)	Deletes a JWT authenticator and updates the managed cluster to apply the settings.
get(string, string, string, JWTAuthenticatorsGetOptionalParams)	Gets the specified JWT authenticator of a managed cluster.
listByManagedCluster(string, string, JWTAuthenticatorsListByManagedClusterOptionalParams)	Gets a list of JWT authenticators in the specified managed cluster.

Method Details

beginCreateOrUpdate(string, string, string, JWTAuthenticator, JWTAuthenticatorsCreateOrUpdateOptionalParams)

Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, jwtAuthenticatorName: string, parameters: JWTAuthenticator, options?: JWTAuthenticatorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JWTAuthenticatorsCreateOrUpdateResponse>, JWTAuthenticatorsCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

jwtAuthenticatorName

string

The name of the JWT authenticator.

parameters

JWTAuthenticator

The JWT authenticator to create or update.

options

JWTAuthenticatorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<JWTAuthenticatorsCreateOrUpdateResponse>, JWTAuthenticatorsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, JWTAuthenticator, JWTAuthenticatorsCreateOrUpdateOptionalParams)

Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, jwtAuthenticatorName: string, parameters: JWTAuthenticator, options?: JWTAuthenticatorsCreateOrUpdateOptionalParams): Promise<JWTAuthenticatorsCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

jwtAuthenticatorName

string

The name of the JWT authenticator.

parameters

JWTAuthenticator

The JWT authenticator to create or update.

options

JWTAuthenticatorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<JWTAuthenticatorsCreateOrUpdateResponse>

beginDelete(string, string, string, JWTAuthenticatorsDeleteOptionalParams)

Deletes a JWT authenticator and updates the managed cluster to apply the settings.

function beginDelete(resourceGroupName: string, resourceName: string, jwtAuthenticatorName: string, options?: JWTAuthenticatorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<JWTAuthenticatorsDeleteHeaders>, JWTAuthenticatorsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

jwtAuthenticatorName

string

The name of the JWT authenticator.

options

JWTAuthenticatorsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<JWTAuthenticatorsDeleteHeaders>, JWTAuthenticatorsDeleteHeaders>>

beginDeleteAndWait(string, string, string, JWTAuthenticatorsDeleteOptionalParams)

Deletes a JWT authenticator and updates the managed cluster to apply the settings.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, jwtAuthenticatorName: string, options?: JWTAuthenticatorsDeleteOptionalParams): Promise<JWTAuthenticatorsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

jwtAuthenticatorName

string

The name of the JWT authenticator.

options

JWTAuthenticatorsDeleteOptionalParams

The options parameters.

Returns

Promise<JWTAuthenticatorsDeleteHeaders>

get(string, string, string, JWTAuthenticatorsGetOptionalParams)

Gets the specified JWT authenticator of a managed cluster.

function get(resourceGroupName: string, resourceName: string, jwtAuthenticatorName: string, options?: JWTAuthenticatorsGetOptionalParams): Promise<JWTAuthenticator>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

jwtAuthenticatorName

string

The name of the JWT authenticator.

options

JWTAuthenticatorsGetOptionalParams

The options parameters.

Returns

Promise<JWTAuthenticator>

listByManagedCluster(string, string, JWTAuthenticatorsListByManagedClusterOptionalParams)

Gets a list of JWT authenticators in the specified managed cluster.

function listByManagedCluster(resourceGroupName: string, resourceName: string, options?: JWTAuthenticatorsListByManagedClusterOptionalParams): PagedAsyncIterableIterator<JWTAuthenticator, JWTAuthenticator[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the managed cluster resource.

options

JWTAuthenticatorsListByManagedClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JWTAuthenticator, JWTAuthenticator[], PageSettings>