CertificatesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:certificates> attribute.
Constructor
CertificatesOperations(*args, **kwargs)Methods
| create_or_update |
Create or update a certificate. Description for Create or update a certificate. |
| delete |
Delete a certificate. Description for Delete a certificate. |
| get |
Get a certificate. Description for Get a certificate. |
| list |
Get all certificates for a subscription. Description for Get all certificates for a subscription. |
| list_by_resource_group |
Get all certificates in a resource group. Description for Get all certificates in a resource group. |
| update |
Create or update a certificate. Description for Create or update a certificate. |
create_or_update
Create or update a certificate.
Description for Create or update a certificate.
async create_or_update(resource_group_name: str, name: str, certificate_envelope: _models.Certificate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CertificateParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the certificate. Required. |
|
certificate_envelope
Required
|
Details of certificate, if it exists already. Is either a Certificate type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Certificate or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Delete a certificate.
Description for Delete a certificate.
async delete(resource_group_name: str, name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the certificate. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a certificate.
Description for Get a certificate.
async get(resource_group_name: str, name: str, **kwargs: Any) -> CertificateParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the certificate. Required. |
Returns
| Type | Description |
|---|---|
|
Certificate or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Get all certificates for a subscription.
Description for Get all certificates for a subscription.
list(filter: str | None = None, **kwargs: Any) -> AsyncItemPaged[Certificate]Parameters
| Name | Description |
|---|---|
|
filter
|
Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Certificate or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
Get all certificates in a resource group.
Description for Get all certificates in a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncItemPaged[Certificate]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Certificate or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Create or update a certificate.
Description for Create or update a certificate.
async update(resource_group_name: str, name: str, certificate_envelope: _models.CertificatePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CertificateParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the certificate. Required. |
|
certificate_envelope
Required
|
Details of certificate, if it exists already. Is either a CertificatePatchResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Certificate or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.web.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv239\\Lib\\site-packages\\azure\\mgmt\\web\\models\\__init__.py'>