azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations
name: SecretsOperations
fullName: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations
module: azure.mgmt.keyvault.v2021_10_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.keyvault.v2021_10_01.KeyVaultManagementClient>'s\n\
  >\n> <xref:secrets> attribute.\n>"
constructor:
  syntax: SecretsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations.create_or_update
  name: create_or_update
  summary: '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.'
  signature: 'create_or_update(resource_group_name: str, vault_name: str, secret_name:
    str, parameters: _models.SecretCreateOrUpdateParameters, *, content_type: str
    = ''application/json'', **kwargs: Any) -> _models.Secret'
  parameters:
  - name: resource_group_name
    description: 'The name of the Resource Group to which the vault belongs.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: Name of the vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: secret_name
    description: 'Name of the secret. The value you provide may be copied globally
      for the

      purpose of running the service. The value provided should not include personally
      identifiable

      or sensitive information. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters to create or update the secret. Is either a

      SecretCreateOrUpdateParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2021_10_01.models.SecretCreateOrUpdateParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Secret or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2021_10_01.models.Secret>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations.get
  name: get
  summary: '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.'
  signature: 'get(resource_group_name: str, vault_name: str, secret_name: str, **kwargs:
    Any) -> Secret'
  parameters:
  - name: resource_group_name
    description: 'The name of the Resource Group to which the vault belongs.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: The name of the vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: secret_name
    description: The name of the secret. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Secret or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2021_10_01.models.Secret>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations.list
  name: list
  summary: '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.'
  signature: 'list(resource_group_name: str, vault_name: str, top: int | None = None,
    **kwargs: Any) -> Iterable[Secret]'
  parameters:
  - name: resource_group_name
    description: 'The name of the Resource Group to which the vault belongs.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: The name of the vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: Maximum number of results to return. Default value is None.
    isRequired: true
    types:
    - <xref:int>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either Secret or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.keyvault.v2021_10_01.models.Secret>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations.update
  name: update
  summary: 'Update a secret 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.'
  signature: 'update(resource_group_name: str, vault_name: str, secret_name: str,
    parameters: _models.SecretPatchParameters, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.Secret'
  parameters:
  - name: resource_group_name
    description: 'The name of the Resource Group to which the vault belongs.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: vault_name
    description: Name of the vault. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: secret_name
    description: Name of the secret. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters to patch the secret. Is either a SecretPatchParameters
      type or a

      IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2021_10_01.models.SecretPatchParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Secret or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2021_10_01.models.Secret>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.keyvault.v2021_10_01.operations.SecretsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.keyvault.v2021_10_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2021_10_01\\models\\__init__.py'>