FederatedIdentityCredentials interface

Package:

@azure/arm-msi

Interface representing a FederatedIdentityCredentials.

Methods

createOrUpdate(string, string, string, FederatedIdentityCredential, FederatedIdentityCredentialsCreateOrUpdateOptionalParams)	Create or update a federated identity credential under the specified user assigned identity.
delete(string, string, string, FederatedIdentityCredentialsDeleteOptionalParams)	Deletes the federated identity credential.
get(string, string, string, FederatedIdentityCredentialsGetOptionalParams)	Gets the federated identity credential.
list(string, string, FederatedIdentityCredentialsListOptionalParams)	Lists all the federated identity credentials under the specified user assigned identity.

Method Details

createOrUpdate(string, string, string, FederatedIdentityCredential, FederatedIdentityCredentialsCreateOrUpdateOptionalParams)

Create or update a federated identity credential under the specified user assigned identity.

function createOrUpdate(resourceGroupName: string, resourceName: string, federatedIdentityCredentialResourceName: string, parameters: FederatedIdentityCredential, options?: FederatedIdentityCredentialsCreateOrUpdateOptionalParams): Promise<FederatedIdentityCredential>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

federatedIdentityCredentialResourceName

string

The name of the federated identity credential resource.

parameters

FederatedIdentityCredential

Parameters to create or update the federated identity credential.

options

FederatedIdentityCredentialsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FederatedIdentityCredential>

delete(string, string, string, FederatedIdentityCredentialsDeleteOptionalParams)

Deletes the federated identity credential.

function delete(resourceGroupName: string, resourceName: string, federatedIdentityCredentialResourceName: string, options?: FederatedIdentityCredentialsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

federatedIdentityCredentialResourceName

string

The name of the federated identity credential resource.

options

FederatedIdentityCredentialsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, FederatedIdentityCredentialsGetOptionalParams)

Gets the federated identity credential.

function get(resourceGroupName: string, resourceName: string, federatedIdentityCredentialResourceName: string, options?: FederatedIdentityCredentialsGetOptionalParams): Promise<FederatedIdentityCredential>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

federatedIdentityCredentialResourceName

string

The name of the federated identity credential resource.

options

FederatedIdentityCredentialsGetOptionalParams

The options parameters.

Returns

Promise<FederatedIdentityCredential>

list(string, string, FederatedIdentityCredentialsListOptionalParams)

Lists all the federated identity credentials under the specified user assigned identity.

function list(resourceGroupName: string, resourceName: string, options?: FederatedIdentityCredentialsListOptionalParams): PagedAsyncIterableIterator<FederatedIdentityCredential, FederatedIdentityCredential[], PageSettings>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

options

FederatedIdentityCredentialsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FederatedIdentityCredential, FederatedIdentityCredential[], PageSettings>