Ca Certificates - List By Namespace
List all CA certificates under a namespace.
Get all the CA certificates under a namespace.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/caCertificates?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&$filter={$filter}&$top={$top}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
namespace
|
path | True |
string |
Name of the namespace. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group within the user's subscription. |
subscription
|
path | True |
string |
Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
$filter
|
query |
string |
The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. |
|
$top
|
query |
integer int32 |
The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response returned if request was unsuccessful. |
Examples
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
Sample response
{
"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"
}
Definitions
Name | Description |
---|---|
Ca |
The CA Certificate resource. |
Ca |
Provisioning state of the CA Certificate resource. |
Ca |
Result of the List CA Certificate operation. |
created |
The type of identity that created the resource. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
system |
Metadata pertaining to creation and last modification of the resource. |
CaCertificate
The CA Certificate resource.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified identifier of the resource. |
name |
string |
Name of the resource. |
properties.description |
string |
Description for the CA Certificate resource. |
properties.encodedCertificate |
string |
Base64 encoded PEM (Privacy Enhanced Mail) format certificate data. |
properties.expiryTimeInUtc |
string |
Certificate expiry time in UTC. This is a read-only field. |
properties.issueTimeInUtc |
string |
Certificate issue time in UTC. This is a read-only field. |
properties.provisioningState |
Provisioning state of the CA Certificate resource. |
|
systemData |
The system metadata relating to the CaCertificate resource. |
|
type |
string |
Type of the resource. |
CaCertificateProvisioningState
Provisioning state of the CA Certificate resource.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleted |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
CaCertificatesListResult
Result of the List CA Certificate operation.
Name | Type | Description |
---|---|---|
nextLink |
string |
A link for the next page of CA Certificate. |
value |
A collection of CA Certificate. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |