Ca Certificates - List By Namespace

Ссылка

Service:: Event Grid

API Version:: 2024-06-01-preview

Вывод списка всех сертификатов ЦС в пространстве имен.
Получите все сертификаты ЦС в пространстве имен.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates?api-version=2024-06-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates?api-version=2024-06-01-preview&$filter={$filter}&$top={$top}

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string	Имя пространства имен. Regex pattern: `^[a-zA-Z0-9-]*$`
resourceGroupName	path	True	string	Имя группы ресурсов в подписке пользователя.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.
$filter	query		string	Запрос, используемый для фильтрации результатов поиска с использованием синтаксиса OData. Фильтрация разрешена только для свойства name и с ограниченным количеством операций OData. Это следующие операции: функция contains, а также следующие логические операции: not, and, or, eq (для равно), и ne (для не равно). Арифметические операции не поддерживаются. Ниже приведен допустимый пример фильтра: $filter=contains(namE, 'PATTERN') и name ne 'PATTERN-1'. Ниже приведен недопустимый пример фильтра: $filter=location eq 'westus'.
$top	query		integer int32	Количество возвращаемых результатов для каждой страницы для операции со списком. Допустимый диапазон для параметра top — от 1 до 100. Если значение не указано, количество возвращаемых результатов по умолчанию составляет 20 элементов на страницу.

Ответы

Имя	Тип	Описание
200 OK	CaCertificatesListResult	ОК
Other Status Codes	ErrorResponse	Если запрос был неудачным, возвращается ответ об ошибке.

Примеры

CaCertificates_ListByNamespace

Sample Request

GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/namespace123/caCertificates?api-version=2024-06-01-preview


/**
 * Samples for CaCertificates ListByNamespace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/examples/
     * CaCertificates_ListByNamespace.json
     */
    /**
     * Sample code: CaCertificates_ListByNamespace.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void caCertificatesListByNamespace(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.caCertificates().listByNamespace("examplerg", "namespace123", null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python ca_certificates_list_by_namespace.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="8f6b6269-84f2-4d09-9e31-1127efcd1e40",
    )

    response = client.ca_certificates.list_by_namespace(
        resource_group_name="examplerg",
        namespace_name="namespace123",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2024-06-01-preview/examples/CaCertificates_ListByNamespace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "encodedCertificate": "base64EncodePemFormattedCertificateString",
        "issueTimeInUtc": "2022-09-12T23:06:43+00:00",
        "expiryTimeInUtc": "2022-10-12T23:06:43+00:00",
        "provisioningState": "Succeeded",
        "description": "This is a test Root certificate"
      },
      "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/caCertificates/exampleCACertificateName1",
      "name": "exampleCACertificateName1",
      "type": "Microsoft.EventGrid/namespaces/caCertificates"
    }
  ],
  "nextLink": "https://xyz.net/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/providers/microsoft.eventgrid/namespaces/namespace123/caCertificates?2024-06-01-preview&%24skiptoken=7ZjtaqQwFIbvRWp%2f1dHJ6GgHypK1yro707F%2bdOn%2bUxPdMJhIkmqh9N43cYfeg6CE%2bB45mI%2bHlxz9MCh%2bl0dCL8I4fBi%2fo7woc%2bNg%2fJVyEAfbrgZiIda1jKENx4K98QaLzUQoYpOwCJUbiqUt3mrRcDJIwqiwkRt4%2b30VWMAFgeVW%2b8YKdq5v3e99Dzn3bR14W3vgbCQIc2H3pOFMsFZu8Iip7DhBtmQDacQ3PfqoctRrH4ADgLV1rK1nDRyPBE%2b3N%2bKixmQXTB9Mrzb92gRgDtXd3FW6B3WWPGrt49F5fYS%2ffP7SJxf4dZk7pBvYZYVK2ypRZKFSwFEyyV%2b01Co6K7X3PE%2bnPIexigKl4lQnwy7SL%2bxgeIIlDKGcTslrB6cu5SZoJ6dpwziCbqqC8ll1QQtDeqp5k81zbFTPK9rh67znhfSEXkO9DNV0Vl%2b9fz2MYy19pJuHbm%2fUnqlNMu6uEMFKcdEU83NZ%2fAijpyKDx9WSC7fk9wz%2bSY4z0tWWi7alPiGjMjun0Qpy0SAjqEud9ZTUBc5ya53%2fFFcrLh4izBO4Ylw0xrm80YZcWS7%2bG%2fInTOGTrnVWTy7Yk593RsV72HUcd5XEqND%2fShRRmJ2Mz38%3d"
}

Определения

Имя	Описание
CaCertificate	Ресурс сертификата ЦС.
CaCertificateProvisioningState	Состояние подготовки ресурса сертификата ЦС.
CaCertificatesListResult	Результат операции с сертификатом ЦС списка.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

CaCertificate

Ресурс сертификата ЦС.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса.
name	string	Имя ресурса.
properties.description	string	Описание ресурса сертификата ЦС.
properties.encodedCertificate	string	Данные сертификата в формате PEM (Privacy Enhanced Mail) в кодировке Base64.
properties.expiryTimeInUtc	string	Время окончания срока действия сертификата в формате UTC. Это поле доступно только для чтения.
properties.issueTimeInUtc	string	Время выдачи сертификата в формате UTC. Это поле доступно только для чтения.
properties.provisioningState	CaCertificateProvisioningState	Состояние подготовки ресурса сертификата ЦС.
systemData	systemData	Системные метаданные, относящиеся к ресурсу CaCertificate.
type	string	Тип ресурса.

CaCertificateProvisioningState

Состояние подготовки ресурса сертификата ЦС.

Имя	Тип	Описание
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

CaCertificatesListResult

Результат операции с сертификатом ЦС списка.

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу сертификата ЦС.
value	CaCertificate[]	Коллекция сертификатов ЦС.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

Поделиться через