Clients interface

Interface representing a Clients.

Methods

beginCreateOrUpdate(string, string, string, Client, ClientsCreateOrUpdateOptionalParams)

Create or update a client with the specified parameters.

beginCreateOrUpdateAndWait(string, string, string, Client, ClientsCreateOrUpdateOptionalParams)

Create or update a client with the specified parameters.

beginDelete(string, string, string, ClientsDeleteOptionalParams)

Delete an existing client.

beginDeleteAndWait(string, string, string, ClientsDeleteOptionalParams)

Delete an existing client.

get(string, string, string, ClientsGetOptionalParams)

Get properties of a client.

listByNamespace(string, string, ClientsListByNamespaceOptionalParams)

Get all the permission bindings under a namespace.

Method Details

beginCreateOrUpdate(string, string, string, Client, ClientsCreateOrUpdateOptionalParams)

Create or update a client with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, clientName: string, clientInfo: Client, options?: ClientsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Client>, Client>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

clientName

string

The client name.

clientInfo
Client

Client information.

options
ClientsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, Client, ClientsCreateOrUpdateOptionalParams)

Create or update a client with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, clientName: string, clientInfo: Client, options?: ClientsCreateOrUpdateOptionalParams): Promise<Client>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

clientName

string

The client name.

clientInfo
Client

Client information.

options
ClientsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Client>

beginDelete(string, string, string, ClientsDeleteOptionalParams)

Delete an existing client.

function beginDelete(resourceGroupName: string, namespaceName: string, clientName: string, options?: ClientsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

clientName

string

Name of the client.

options
ClientsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ClientsDeleteOptionalParams)

Delete an existing client.

function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, clientName: string, options?: ClientsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

clientName

string

Name of the client.

options
ClientsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ClientsGetOptionalParams)

Get properties of a client.

function get(resourceGroupName: string, namespaceName: string, clientName: string, options?: ClientsGetOptionalParams): Promise<Client>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

clientName

string

Name of the client.

options
ClientsGetOptionalParams

The options parameters.

Returns

Promise<Client>

listByNamespace(string, string, ClientsListByNamespaceOptionalParams)

Get all the permission bindings under a namespace.

function listByNamespace(resourceGroupName: string, namespaceName: string, options?: ClientsListByNamespaceOptionalParams): PagedAsyncIterableIterator<Client, Client[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

namespaceName

string

Name of the namespace.

options
ClientsListByNamespaceOptionalParams

The options parameters.

Returns