verified_partners
Creates, updates, deletes, gets or lists a verified_partners resource.
Overview
| Name | verified_partners |
| Type | Resource |
| Id | azure.event_grid.verified_partners |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
organizationName | string | Official name of the Partner. |
partnerDestinationDetails | object | Details of the partner destination scenario. |
partnerDisplayName | string | Display name of the verified partner. |
partnerRegistrationImmutableId | string | ImmutableId of the corresponding partner registration. |
partnerTopicDetails | object | Details of the partner topic scenario. |
provisioningState | string | Provisioning state of the verified partner. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
organizationName | string | Official name of the Partner. |
partnerDestinationDetails | object | Details of the partner destination scenario. |
partnerDisplayName | string | Display name of the verified partner. |
partnerRegistrationImmutableId | string | ImmutableId of the corresponding partner registration. |
partnerTopicDetails | object | Details of the partner topic scenario. |
provisioningState | string | Provisioning state of the verified partner. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | verified_partner_name | Get a verified partner. Get properties of a verified partner. | |
list | select | $filter, $top | List all verified partners. Get a list of all verified partners. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
verified_partner_name | string | Name of the verified partner. Required. |
$filter | 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'. Default value is None. |
$top | integer | 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. Default value is None. |
SELECT examples
- get
- list
Get a verified partner. Get properties of a verified partner.
SELECT
id,
name,
organizationName,
partnerDestinationDetails,
partnerDisplayName,
partnerRegistrationImmutableId,
partnerTopicDetails,
provisioningState,
systemData,
type
FROM azure.event_grid.verified_partners
WHERE verified_partner_name = '{{ verified_partner_name }}' -- required
;
List all verified partners. Get a list of all verified partners.
SELECT
id,
name,
organizationName,
partnerDestinationDetails,
partnerDisplayName,
partnerRegistrationImmutableId,
partnerTopicDetails,
provisioningState,
systemData,
type
FROM azure.event_grid.verified_partners
WHERE $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;