azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations
name: CertificatesOperations
fullName: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations
module: azure.mgmt.web.v2023_01_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.web.v2023_01_01.WebSiteManagementClient>'s\n\
  >\n> <xref:certificates> attribute.\n>"
constructor:
  syntax: CertificatesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.create_or_update
  name: create_or_update
  summary: 'Create or update a certificate.


    Description for Create or update a certificate.'
  signature: 'create_or_update(resource_group_name: str, name: str, certificate_envelope:
    _models.Certificate, *, content_type: str = ''application/json'', **kwargs: Any)
    -> _models.Certificate'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_envelope
    description: 'Details of certificate, if it exists already. Is either a

      Certificate type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2023_01_01.models.Certificate>
    - <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: Certificate or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2023_01_01.models.Certificate>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.delete
  name: delete
  summary: 'Delete a certificate.


    Description for Delete a certificate.'
  signature: 'delete(resource_group_name: str, name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the certificate. 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: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.get
  name: get
  summary: 'Get a certificate.


    Description for Get a certificate.'
  signature: 'get(resource_group_name: str, name: str, **kwargs: Any) -> Certificate'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the certificate. 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: Certificate or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2023_01_01.models.Certificate>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.list
  name: list
  summary: 'Get all certificates for a subscription.


    Description for Get all certificates for a subscription.'
  signature: 'list(filter: str | None = None, **kwargs: Any) -> Iterable[Certificate]'
  parameters:
  - name: filter
    description: 'Return only information specified in the filter (using OData syntax).
      For

      example: $filter=KeyVaultId eq ''KeyVaultId''. Default value is None.'
    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: An iterator like instance of either Certificate or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2023_01_01.models.Certificate>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.list_by_resource_group
  name: list_by_resource_group
  summary: 'Get all certificates in a resource group.


    Description for Get all certificates in a resource group.'
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Certificate]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. 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: An iterator like instance of either Certificate or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2023_01_01.models.Certificate>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.update
  name: update
  summary: 'Create or update a certificate.


    Description for Create or update a certificate.'
  signature: 'update(resource_group_name: str, name: str, certificate_envelope: _models.CertificatePatchResource,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.Certificate'
  parameters:
  - name: resource_group_name
    description: Name of the resource group to which the resource belongs. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the certificate. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: certificate_envelope
    description: 'Details of certificate, if it exists already. Is either a

      CertificatePatchResource type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2023_01_01.models.CertificatePatchResource>
    - <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: Certificate or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2023_01_01.models.Certificate>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.web.v2023_01_01.operations.CertificatesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.web.v2023_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2023_01_01\\models\\__init__.py'>