partner
Creates, updates, deletes, gets or lists a partner resource.
Overview
| Name | partner |
| Type | Resource |
| Id | azure_extras.management_partner.partner |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier of the partner. |
name | string | Name of the partner. |
createdTime | string (date-time) | This is the DateTime when the partner was created. |
etag | integer | Type of the partner. |
objectId | string | This is the object id. |
partnerId | string | This is the partner id. |
partnerName | string | This is the partner name. |
state | string | This is the partner state. Known values are: "Active" and "Deleted". |
tenantId | string | This is the tenant id. |
type | string | Type of resource. "Microsoft.ManagementPartner/partners". |
updatedTime | string (date-time) | This is the DateTime when the partner was updated. |
version | integer | This is the version. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | partner_id | Get a specific Partner. Get the management partner using the partnerId, objectId and tenantId. | |
create | insert | partner_id | Create a specific Partner. Create a management partner for the objectId and tenantId. | |
update | update | partner_id | Update a specific Partner. Update the management partner for the objectId and tenantId. | |
delete | delete | partner_id | Delete a specific Partner. Delete the management partner for the objectId and tenantId. |
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 |
|---|---|---|
partner_id | string | Id of the Partner. Required. |
SELECT examples
- get
Get a specific Partner. Get the management partner using the partnerId, objectId and tenantId.
SELECT
id,
name,
createdTime,
etag,
objectId,
partnerId,
partnerName,
state,
tenantId,
type,
updatedTime,
version
FROM azure_extras.management_partner.partner
WHERE partner_id = '{{ partner_id }}' -- required
;
INSERT examples
- create
- Manifest
Create a specific Partner. Create a management partner for the objectId and tenantId.
INSERT INTO azure_extras.management_partner.partner (
partner_id
)
SELECT
'{{ partner_id }}'
RETURNING
id,
name,
etag,
properties,
type
;
# Description fields are for documentation purposes
- name: partner
props:
- name: partner_id
value: "{{ partner_id }}"
description: Required parameter for the partner resource.
UPDATE examples
- update
Update a specific Partner. Update the management partner for the objectId and tenantId.
UPDATE azure_extras.management_partner.partner
SET
-- No updatable properties
WHERE
partner_id = '{{ partner_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;
DELETE examples
- delete
Delete a specific Partner. Delete the management partner for the objectId and tenantId.
DELETE FROM azure_extras.management_partner.partner
WHERE partner_id = '{{ partner_id }}' --required
;