KeyVaultSecretCollection Class

Definition

A class representing a collection of KeyVaultSecretResource and their operations. Each KeyVaultSecretResource in the collection will belong to the same instance of KeyVaultResource. To get a KeyVaultSecretCollection instance call the GetKeyVaultSecrets method from an instance of KeyVaultResource.

public class KeyVaultSecretCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>
type KeyVaultSecretCollection = class
    inherit ArmCollection
    interface seq<KeyVaultSecretResource>
    interface IEnumerable
    interface IAsyncEnumerable<KeyVaultSecretResource>
Public Class KeyVaultSecretCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of KeyVaultSecretResource), IEnumerable(Of KeyVaultSecretResource)
Inheritance
KeyVaultSecretCollection
Implements

Constructors

KeyVaultSecretCollection()

Initializes a new instance of the KeyVaultSecretCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, KeyVaultSecretCreateOrUpdateContent, CancellationToken)

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_CreateOrUpdate
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
CreateOrUpdateAsync(WaitUntil, String, KeyVaultSecretCreateOrUpdateContent, CancellationToken)

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_CreateOrUpdate
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
Get(String, CancellationToken)

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
GetAll(Nullable<Int32>, CancellationToken)

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets
  • Operation Id: Secrets_List
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
GetAllAsync(Nullable<Int32>, CancellationToken)

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets
  • Operation Id: Secrets_List
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
GetAsync(String, CancellationToken)

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<KeyVaultSecretResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<KeyVaultSecretResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to