Pinecone.VectorDb (preview:2024-10-22)

2024/12/11 • 7 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Pinecone.VectorDb/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_ListBySubscription (new)
Description :  List OrganizationResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Pinecone.VectorDb/organizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OrganizationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_ListByResourceGroup (new)
Description :  List OrganizationResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Pinecone.VectorDb/organizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OrganizationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_Get (new)
Description :  Get a OrganizationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Pinecone.VectorDb/organizations/{organizationname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationname:
{
Description: Name of the Organization resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_CreateOrUpdate (new)
Description :  Create a OrganizationResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Pinecone.VectorDb/organizations/{organizationname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationname:
{
Description: Name of the Organization resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete tracked resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_Update (new)
Description :  Update a OrganizationResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Pinecone.VectorDb/organizations/{organizationname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationname:
{
Description: Name of the Organization resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplace:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: Azure subscription id for the the marketplace offer is purchased from ,
Required: True ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Plan Display Name for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
user:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: True ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: True ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerProperties:
{
Description: partner properties ,
Required: False ,
}
{
displayName:
{
Description: Pinecone Organization Name ,
Required: True ,
}
string ,
}
,
singleSignOnProperties:
{
Description: Single sign-on properties ,
Required: False ,
}
{
type:
{
Description: Type of Single Sign-On mechanism being used ,
Enum:
{
Saml: Security Assertion Markup Language (SAML) based Single Sign-On ,
OpenId: OpenID Connect based Single Sign-On. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: State of the Single Sign On for the resource ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: State of the SSO resource when it is enabled ,
Disable: State of the SSO resource when it is disabled ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
url:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_Delete (new)
Description :  Delete a OrganizationResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Pinecone.VectorDb/organizations/{organizationname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationname:
{
Description: Name of the Organization resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}