diff --git a/.gitattributes b/.gitattributes index 4cab1f4d2676..6f1751c1ef3c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,2 @@ -# Set the default behavior, in case people don't have core.autocrlf set. -* text=auto +# Use unix line endings always, even on Windows +* text=auto eol=lf diff --git a/.github/policies/resourceManagement.yml b/.github/policies/resourceManagement.yml index 0692601f9a51..7717446efda4 100644 --- a/.github/policies/resourceManagement.yml +++ b/.github/policies/resourceManagement.yml @@ -1,3947 +1,3947 @@ -id: -name: GitOps.PullRequestIssueManagement -description: GitOps.PullRequestIssueManagement primitive -owner: -resource: repository -disabled: false -where: -configuration: - resourceManagementConfiguration: - scheduledSearches: - - description: - frequencies: - - daily: - time: 1:0 - filters: - - isIssue - - isOpen - - hasLabel: - label: needs-author-feedback - - hasLabel: - label: no-recent-activity - - noActivitySince: - days: 14 - actions: - - closeIssue - - description: - frequencies: - - hourly: - hour: 6 - filters: - - isIssue - - isOpen - - hasLabel: - label: needs-author-feedback - - noActivitySince: - days: 7 - - isNotLabeledWith: - label: no-recent-activity - actions: - - addLabel: - label: no-recent-activity - - addReply: - reply: Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next **7 days**. If we don't hear back from you within **14 days** of this comment the issue will be automatically closed. Thank you! - - description: - frequencies: - - weekday: - day: Monday - time: 0:0 - filters: - - noActivitySince: - days: 14 - - isOpen - - isNotLabeledWith: - label: no-recent-activity - - isNotLabeledWith: - label: customer-reported - - isPullRequest - - isNotDraftPullRequest - actions: - - addReply: - reply: 'Hi, @${issueAuthor}. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove `no-recent-activity` label. ' - - addLabel: - label: no-recent-activity - - description: - frequencies: - - daily: - time: 13:0 - filters: - - isOpen - - hasLabel: - label: no-recent-activity - - noActivitySince: - days: 14 - - isNotLabeledWith: - label: customer-reported - actions: - - closeIssue - - addReply: - reply: Hi, @${issueAuthor}. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. - eventResponderTasks: - - if: - - payloadType: Issue_Comment - - isAction: - action: Created - - isActivitySender: - issueAuthor: True - - hasLabel: - label: needs-author-feedback - - isOpen - then: - - addLabel: - label: needs-team-attention - - removeLabel: - label: needs-author-feedback - description: - - if: - - payloadType: Issues - - not: - isAction: - action: Closed - - hasLabel: - label: no-recent-activity - then: - - removeLabel: - label: no-recent-activity - description: - - if: - - payloadType: Issue_Comment - - hasLabel: - label: no-recent-activity - then: - - removeLabel: - label: no-recent-activity - description: - - if: - - payloadType: Issues - - isAction: - action: Labeled - - hasLabel: - label: needs-triage - - not: - labelAdded: - label: needs-triage - then: - - removeLabel: - label: needs-triage - description: - - if: - - payloadType: Issues - - isOpen - - hasLabel: - label: customer-reported - - labelRemoved: - label: Service Attention - then: - - addLabel: - label: needs-team-triage - description: - - if: - - payloadType: Issues - - isAction: - action: Opened - - and: - - not: - activitySenderHasPermission: - permission: Write - - not: - activitySenderHasAssociation: - association: Member - - not: - activitySenderHasAssociation: - association: Collaborator - - not: - activitySenderHasPermission: - permission: Admin - then: - - addLabel: - label: question - description: - - if: - - or: - - payloadType: Issues - - isAction: - action: Opened - then: - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: AKS - then: - - mentionUsers: - mentionees: - - Azure/aks-pm - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Alerts Management - then: - - mentionUsers: - mentionees: - - liadtal - - yairgil - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - then: - - mentionUsers: - mentionees: - - josephkwchan - - jennyhunter-msft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - Templates - then: - - mentionUsers: - mentionees: - - Azure/deployments-owners - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - Tags - then: - - mentionUsers: - mentionees: - - rthorn17 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - Core - then: - - mentionUsers: - mentionees: - - josephkwchan - - jennyhunter-msft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - Managed Applications - then: - - mentionUsers: - mentionees: - - MSEvanhi - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - Service Catalog - then: - - mentionUsers: - mentionees: - - MSEvanhi - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARM - RBAC - then: - - mentionUsers: - mentionees: - - LizMS - - cbrooksmsft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Advisor - then: - - mentionUsers: - mentionees: - - mojayara - - Prasanna-Padmanabhan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Analysis Services - then: - - mentionUsers: - mentionees: - - athipp - - taiwu - - minghan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: API Management - then: - - mentionUsers: - mentionees: - - adrianhall - - KedarJoshi - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Application Insights - then: - - mentionUsers: - mentionees: - - azmonapplicationinsights - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: App Services - then: - - mentionUsers: - mentionees: - - antcp - - AzureAppServiceCLI - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: App Configuration - then: - - mentionUsers: - mentionees: - - jiayi11 - - avanigupta - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ARO - then: - - mentionUsers: - mentionees: - - mjudeikis - - jim-minter - - julienstroheker - - amanohar - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Attestation - then: - - mentionUsers: - mentionees: - - anilba06 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Authorization - then: - - mentionUsers: - mentionees: - - darshanhs90 - - AshishGargMicrosoft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Automation - then: - - mentionUsers: - mentionees: - - jaspkaur28 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: AVS - then: - - mentionUsers: - mentionees: - - divka78 - - amitchat - - aishu - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Azure Stack - then: - - mentionUsers: - mentionees: - - sijuman - - sarathys - - bganapa - - rakku-ms - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Batch - then: - - mentionUsers: - mentionees: - - cRui861 - - paterasMSFT - - gingi - - dpwatrous - - mksuni - - bgklein - - mscurrell - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: BatchAI - then: - - mentionUsers: - mentionees: - - matthchr - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Billing - then: - - mentionUsers: - mentionees: - - cabbpt - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Blueprint - then: - - mentionUsers: - mentionees: - - alex-frankel - - filizt - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Bot Service - then: - - mentionUsers: - mentionees: - - sgellock - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cloud Shell - then: - - mentionUsers: - mentionees: - - maertendMSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Text Analytics - then: - - mentionUsers: - mentionees: - - assafi - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Form Recognizer - then: - - mentionUsers: - mentionees: - - ctstone - - anrothMSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Anomaly Detector - then: - - mentionUsers: - mentionees: - - yingqunpku - - bowgong - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Custom Vision - then: - - mentionUsers: - mentionees: - - areddish - - tburns10 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Computer Vision - then: - - mentionUsers: - mentionees: - - ryogok - - TFR258 - - tburns10 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Face - then: - - mentionUsers: - mentionees: - - JinyuID - - dipidoo - - SteveMSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - QnA Maker - then: - - mentionUsers: - mentionees: - - bingisbestest - - nerajput1607 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Translator - then: - - mentionUsers: - mentionees: - - swmachan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Speech - then: - - mentionUsers: - mentionees: - - robch - - oscholz - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - LUIS - then: - - mentionUsers: - mentionees: - - cahann - - kayousef - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Content Moderator - then: - - mentionUsers: - mentionees: - - swiftarrow11 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Personalizer - then: - - mentionUsers: - mentionees: - - dwaijam - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Immersive Reader - then: - - mentionUsers: - mentionees: - - metanMSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Ink Recognizer - then: - - mentionUsers: - mentionees: - - olduroja - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Bing - then: - - mentionUsers: - mentionees: - - jaggerbodas-ms - - arwong - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cognitive - Mgmt - then: - - mentionUsers: - mentionees: - - yangyuan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Commerce - then: - - mentionUsers: - mentionees: - - ms-premp - - qiaozha - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - then: - - mentionUsers: - mentionees: - - Drewm3 - - TravisCragg-MSFT - - nikhilpatel909 - - sandeepraichura - - hilaryw29 - - GabstaMSFT - - ramankumarlive - - ushnaarshadkhan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - Extensions - then: - - mentionUsers: - mentionees: - - TravisCragg-MSFT - - GabstaMSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - Images - then: - - mentionUsers: - mentionees: - - TravisCragg-MSFT - - sandeepraichura - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - Managed Disks - then: - - mentionUsers: - mentionees: - - TravisCragg-MSFT - - ramankumarlive - - ushnaarshadkhan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - RDFE - then: - - mentionUsers: - mentionees: - - Drewm3 - - TravisCragg-MSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - VM - then: - - mentionUsers: - mentionees: - - Drewm3 - - TravisCragg-MSFT - - nikhilpatel909 - - sandeepraichura - - hilaryw29 - - GabstaMSFT - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Compute - VMSS - then: - - mentionUsers: - mentionees: - - TravisCragg-MSFT - - hilaryw29 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Connected Kubernetes - then: - - mentionUsers: - mentionees: - - akashkeshari - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Container Instances - then: - - mentionUsers: - mentionees: - - macolso - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Container Registry - then: - - mentionUsers: - mentionees: - - toddysm - - luisdlp - - northtyphoon - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Container Service - then: - - mentionUsers: - mentionees: - - qike-ms - - jwilder - - thomas1206 - - seanmck - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cosmos - then: - - mentionUsers: - mentionees: - - pjohari-ms - - MehaKaushik - - zfoster - - kushagraThapar - - simorenoh - - simplynaveen20 - - abinav2307 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Customer Insights - then: - - mentionUsers: - mentionees: - - shefymk - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Custom Providers - then: - - mentionUsers: - mentionees: - - manoharp - - MSEvanhi - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: CycleCloud - then: - - mentionUsers: - mentionees: - - adriankjohnson - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Bricks - then: - - mentionUsers: - mentionees: - - arindamc - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: DataBox - then: - - mentionUsers: - mentionees: - - tmvishwajit - - matdickson - - manuaery - - madhurinms - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: DataBox Edge - then: - - mentionUsers: - mentionees: - - a-t-mason - - ganzee - - manuaery - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Catalog - then: - - mentionUsers: - mentionees: - - ingave - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Factory - then: - - mentionUsers: - mentionees: - - Jingshu923 - - zhangyd2015 - - Frey-Wang - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Lake - then: - - mentionUsers: - mentionees: - - sumantmehtams - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Lake Storage Gen1 - then: - - mentionUsers: - mentionees: - - sumantmehtams - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Lake Storage Gen2 - then: - - mentionUsers: - mentionees: - - sumantmehtams - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Lake Analytics - then: - - mentionUsers: - mentionees: - - idear1203 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Lake Store - then: - - mentionUsers: - mentionees: - - sumantmehtams - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Migration - then: - - mentionUsers: - mentionees: - - radjaram - - kavitham10 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Data Share - then: - - mentionUsers: - mentionees: - - raedJarrar - - jifems - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: DevOps - then: - - mentionUsers: - mentionees: - - v-anvashist - - V-hmusukula - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Dev Spaces - then: - - mentionUsers: - mentionees: - - yuzorMa - - johnsta - - greenie-msft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Devtestlab - then: - - mentionUsers: - mentionees: - - Tanmayeekamath - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Device Provisioning Service - then: - - mentionUsers: - mentionees: - - nberdy - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Digital Twins - then: - - mentionUsers: - mentionees: - - sourabhguha - - inesk-vt - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Event Grid - then: - - mentionUsers: - mentionees: - - jfggdl - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Event Hubs - then: - - mentionUsers: - mentionees: - - Saglodha - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Functions - then: - - mentionUsers: - mentionees: - - Stefanus Hinardi - - Francisco-Gamino - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Graph.Microsoft - then: - - mentionUsers: - mentionees: - - dkershaw10 - - baywet - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Guest Configuration - then: - - mentionUsers: - mentionees: - - mgreenegit - - vivlingaiah - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: HDInsight - then: - - mentionUsers: - mentionees: - - aim-for-better - - idear1203 - - deshriva - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: HPC Cache - then: - - mentionUsers: - mentionees: - - romahamu - - omzevall - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Import Export - then: - - mentionUsers: - mentionees: - - madhurinms - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: KeyVault - then: - - mentionUsers: - mentionees: - - RandalliLama - - schaabs - - jlichwa - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Kubernetes Configuration - then: - - mentionUsers: - mentionees: - - NarayanThiru - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Azure Data Explorer - then: - - mentionUsers: - mentionees: - - ilayrn - - orhasban - - zoharHenMicrosoft - - sagivf - - Aviv-Yaniv - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Lab Services - then: - - mentionUsers: - mentionees: - - Tanmayeekamath - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Logic App - then: - - mentionUsers: - mentionees: - - Azure/azure-logicapps-team - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: LOUIS - then: - - mentionUsers: - mentionees: - - minamnmik - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Machine Learning - then: - - mentionUsers: - mentionees: - - azureml-github - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Machine Learning Compute - then: - - mentionUsers: - mentionees: - - azureml-github - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Machine Learning Experimentation - then: - - mentionUsers: - mentionees: - - aashishb - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Managed Services - then: - - mentionUsers: - mentionees: - - Lighthouse-Azure - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: MariaDB - then: - - mentionUsers: - mentionees: - - ambhatna - - savjani - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Marketplace Ordering - then: - - mentionUsers: - mentionees: - - prbansa - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Media Services - then: - - mentionUsers: - mentionees: - - akucer - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Migrate - then: - - mentionUsers: - mentionees: - - shijojoy - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Mobile Engagement - then: - - mentionUsers: - mentionees: - - kpiteira - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - then: - - mentionUsers: - mentionees: - - SameergMS - - dadunl - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - Autoscale - then: - - mentionUsers: - mentionees: - - AzMonEssential - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - ActivityLogs - then: - - mentionUsers: - mentionees: - - AzMonEssential - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - Metrics - then: - - mentionUsers: - mentionees: - - AzMonEssential - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - Diagnostic Settings - then: - - mentionUsers: - mentionees: - - AzMonEssential - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - Alerts - then: - - mentionUsers: - mentionees: - - AzmonAlerts - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - ActionGroups - then: - - mentionUsers: - mentionees: - - AzmonActionG - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - LogAnalytics - then: - - mentionUsers: - mentionees: - - AzmonLogA - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Monitor - ApplicationInsights - then: - - mentionUsers: - mentionees: - - azmonapplicationinsights - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: MySQL - then: - - mentionUsers: - mentionees: - - ambhatna - - savjani - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - then: - - mentionUsers: - mentionees: - - aznetsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Application Gateway - then: - - mentionUsers: - mentionees: - - appgwsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - CDN - then: - - mentionUsers: - mentionees: - - t-bzhan - - gxue - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - DDOS Protection - then: - - mentionUsers: - mentionees: - - ddossuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - ExpressRoute - then: - - mentionUsers: - mentionees: - - exrsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Firewall - then: - - mentionUsers: - mentionees: - - fwsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Front Door - then: - - mentionUsers: - mentionees: - - cdnfdsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Load Balancer - then: - - mentionUsers: - mentionees: - - slbsupportgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Virtual Network NAT - then: - - mentionUsers: - mentionees: - - vnetsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Network Watcher - then: - - mentionUsers: - mentionees: - - netwatchsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - DNS - then: - - mentionUsers: - mentionees: - - dnssuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Traffic Manager - then: - - mentionUsers: - mentionees: - - tmsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - VPN Gateway - then: - - mentionUsers: - mentionees: - - vpngwsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Notification Hub - then: - - mentionUsers: - mentionees: - - tjsomasundaram - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Operational Insights - then: - - mentionUsers: - mentionees: - - AzmonLogA - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Policy - then: - - mentionUsers: - mentionees: - - aperezcloud - - kenieva - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Policy Insights - then: - - mentionUsers: - mentionees: - - kenieva - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: PostgreSQL - then: - - mentionUsers: - mentionees: - - sunilagarwal - - lfittl-msft - - sr-msft - - niklarin - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Recovery Services Backup - then: - - mentionUsers: - mentionees: - - pvrk - - adityabalaji-msft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Recovery Services Site-Recovery - then: - - mentionUsers: - mentionees: - - Sharmistha-Rai - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Redis Cache - then: - - mentionUsers: - mentionees: - - yegu-ms - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Relay - then: - - mentionUsers: - mentionees: - - jfggdl - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Reservations - then: - - mentionUsers: - mentionees: - - Rkapso - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Resource Authorization - then: - - mentionUsers: - mentionees: - - darshanhs90 - - AshishGargMicrosoft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Resource Graph - then: - - mentionUsers: - mentionees: - - chiragg4u - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Resource Health - then: - - mentionUsers: - mentionees: - - stephbaron - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Scheduler - then: - - mentionUsers: - mentionees: - - derek1ee - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Search - then: - - mentionUsers: - mentionees: - - bleroy - - tjacobhi - - markheff - - miwelsh - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Security - then: - - mentionUsers: - mentionees: - - chlahav - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Service Bus - then: - - mentionUsers: - mentionees: - - Saglodha - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Service Fabric - then: - - mentionUsers: - mentionees: - - QingChenmsft - - vaishnavk - - juhacket - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Schema Registry - then: - - mentionUsers: - mentionees: - - arerlend - - alzimmermsft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SignalR - then: - - mentionUsers: - mentionees: - - sffamily - - chenkennt - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - VM - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - Backup & Restore - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - Data Security - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - Elastic Jobs - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - Managed Instance - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SQL - Replication & Failover - then: - - mentionUsers: - mentionees: - - azureSQLGitHub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Storage - then: - - mentionUsers: - mentionees: - - xgithubtriage - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Storsimple - then: - - mentionUsers: - mentionees: - - anoobbacker - - ganzee - - manuaery - - patelkunal - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Stream Analytics - then: - - mentionUsers: - mentionees: - - atpham256 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Subscription - then: - - mentionUsers: - mentionees: - - anuragdalmia - - shilpigautam - - ramaganesan-rg - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Support - then: - - mentionUsers: - mentionees: - - shahbj79 - - mit2nil - - aygoya - - ganganarayanan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Synapse - then: - - mentionUsers: - mentionees: - - wonner - - yanjungao718 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Tables - then: - - mentionUsers: - mentionees: - - klaaslanghout - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: TimeseriesInsights - then: - - mentionUsers: - mentionees: - - Shipra1Mishra - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: vFXT - then: - - mentionUsers: - mentionees: - - zhusijia26 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Web Apps - then: - - mentionUsers: - mentionees: - - AzureAppServiceCLI - - antcp - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Virtual Network - then: - - mentionUsers: - mentionees: - - vnetsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Virtual WAN - then: - - mentionUsers: - mentionees: - - vwansuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Network Virtual Appliance - then: - - mentionUsers: - mentionees: - - nvasuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Bastion - then: - - mentionUsers: - mentionees: - - bastionsuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: IoT/CLI - then: - - mentionUsers: - mentionees: - - Azure/azure-iot-cli-triage - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Azure.Spring - Cosmos - then: - - mentionUsers: - mentionees: - - kushagraThapur - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Network - Private Link - then: - - mentionUsers: - mentionees: - - privlinksuppgithub - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Azure arc enabled servers - then: - - mentionUsers: - mentionees: - - rpsqrd - - edyoung - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: SecurityInsights - then: - - mentionUsers: - mentionees: - - amirkeren - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Azure Data Explorer - then: - - mentionUsers: - mentionees: - - Ilayrn - - orhasban - - zoharHenMicrosoft - - sagivf - - Aviv-Yaniv - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Communication - then: - - mentionUsers: - mentionees: - - acsdevx-msft - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cost Management and Consumption - then: - - mentionUsers: - mentionees: - - ccmaxpcrew - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: ML-AutoML - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - Aniththa - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Hyperdrive - then: - - mentionUsers: - mentionees: - - Aniththa - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Compute - then: - - mentionUsers: - mentionees: - - nishankgu - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Core UI - then: - - mentionUsers: - mentionees: - - abeomor - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Data4ML - then: - - mentionUsers: - mentionees: - - SturgeonMi - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Designer - then: - - mentionUsers: - mentionees: - - alainli0928 - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Data Labeling - then: - - mentionUsers: - mentionees: - - kvijaykannan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-Inference - then: - - mentionUsers: - mentionees: - - shivanissambare - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ML-MLOps - then: - - mentionUsers: - mentionees: - - lostmygithubaccount - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: ML-Pipelines - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - shbijlan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: ML-Responsible AI - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - minthigpen - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: ML-Reinforcement Learning - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - keijik - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: ML-Training - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - lostmygithubaccount - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: ML-Workspace Management - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - rastala - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Spring Cloud - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - ShichaoQiu - - yuwzho - - yucwan - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cost Management-Budget - then: - - mentionUsers: - mentionees: - - ccmaxpcrew - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Consumption-Budget - then: - - mentionUsers: - mentionees: - - ccmaxpcrew - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cost Management-Query - then: - - mentionUsers: - mentionees: - - ccmixpdevs - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Consumption-Query - then: - - mentionUsers: - mentionees: - - ccmixpdevs - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cost Management-Billing - then: - - mentionUsers: - mentionees: - - ccmbpxpcrew - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Consumption-Billing - then: - - mentionUsers: - mentionees: - - ccmbpxpcrew - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cost Management-UsageDetailsAndExport - then: - - mentionUsers: - mentionees: - - TiagoCrewGitHubIssues - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Consumption-UsageDetailsandExport - then: - - mentionUsers: - mentionees: - - TiagoCrewGitHubIssues - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Consumption- RIandShowBack - then: - - mentionUsers: - mentionees: - - ccmshowbackdevs - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Serial Console - then: - - mentionUsers: - mentionees: - - CraigWiand - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Monitor - Exporter - - hasLabel: - label: Service Attention - then: - - mentionUsers: - mentionees: - - cijothomas - - reyang - - rajkumar-rangaraj - - TimothyMothra - - vishweshbankwar - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: Cost Management-RIandShowBack - then: - - mentionUsers: - mentionees: - - ccmshowbackdevs - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - - if: - - hasLabel: - label: Service Attention - - hasLabel: - label: ContainerApp - then: - - mentionUsers: - mentionees: - - calvinsID - replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. - assignMentionees: False - description: - - if: - - payloadType: Pull_Request - - isAction: - action: Opened - - and: - - not: - activitySenderHasPermission: - permission: Write - - not: - activitySenderHasAssociation: - association: Member - - not: - activitySenderHasAssociation: - association: Collaborator - - not: - activitySenderHasPermission: - permission: Admin - then: - - addLabel: - label: customer-reported - - addReply: - reply: Thank you for your contribution ${issueAuthor}! We will review the pull request and get back to you soon. - description: - - if: - - payloadType: Pull_Request - - hasLabel: - label: no-recent-activity - - or: - - isAction: - action: Synchronize - - isAction: - action: Null - - isAction: - action: Unlabeled - - isAction: - action: Edited - - isAction: - action: Null - - isAction: - action: Reopened - - isAction: - action: Labeled - - isAction: - action: Edited - then: - - removeLabel: - label: no-recent-activity - description: - - if: - - payloadType: Pull_Request - then: - - if: - - includesModifiedFiles: - files: - - specification/apimanagement/resource-manager - then: - - addLabel: - label: API Management - - if: - - includesModifiedFiles: - files: - - specification/compute/resource-manager - then: - - addLabel: - label: Compute - - if: - - includesModifiedFiles: - files: - - specification/network/resource-manager - then: - - addLabel: - label: Network - - if: - - includesModifiedFiles: - files: - - specification/sql/resource-manager - then: - - addLabel: - label: SQL - - if: - - includesModifiedFiles: - files: - - specification/storage/resource-manager - then: - - addLabel: - label: Storage - - if: - - includesModifiedFiles: - files: - - specification/synapse - then: - - addLabel: - label: Synapses - description: - - if: - - payloadType: Issue_Comment - - hasLabel: - label: no-recent-activity - - isOpen - then: - - removeLabel: - label: no-recent-activity - description: - - if: - - payloadType: Issues - - isAction: - action: Opened - - and: - - not: - activitySenderHasPermission: - permission: Write - - not: - activitySenderHasAssociation: - association: Member - - not: - activitySenderHasAssociation: - association: Collaborator - - not: - activitySenderHasPermission: - permission: Admin - then: - - addLabel: - label: customer-reported - - addLabel: - label: question - description: - - if: - - payloadType: Pull_Request - then: - - if: - - includesModifiedFiles: - files: - - dev/cognitiveservices/data-plane/Language/ - excludedFiles: - - '' - then: - - addLabel: - label: Cognitive Services - - if: - - includesModifiedFiles: - files: - - specification/analysisservices/ - excludedFiles: - - '' - then: - - addLabel: - label: Analysis Services - - if: - - includesModifiedFiles: - files: - - specification/alertsmanagement/ - excludedFiles: - - '' - then: - - addLabel: - label: Alerts Management - - if: - - includesModifiedFiles: - files: - - specification/apimanagement/ - excludedFiles: - - '' - then: - - addLabel: - label: API Management - - if: - - includesModifiedFiles: - files: - - specification/applicationinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: Insights - - if: - - includesModifiedFiles: - files: - - specification/applicationinsights/data-plane/Monitor.Exporters/ - excludedFiles: - - '' - then: - - addLabel: - label: Monitor - Exporter - - if: - - includesModifiedFiles: - files: - - specification/authorization/ - excludedFiles: - - '' - then: - - addLabel: - label: Authorization - - if: - - includesModifiedFiles: - files: - - specification/automation/ - excludedFiles: - - '' - then: - - addLabel: - label: Automation - - if: - - includesModifiedFiles: - files: - - specification/batch/ - excludedFiles: - - '' - then: - - addLabel: - label: Batch - - if: - - includesModifiedFiles: - files: - - specification/batchai/ - excludedFiles: - - '' - then: - - addLabel: - label: BatchAI - - if: - - includesModifiedFiles: - files: - - specification/billing/ - excludedFiles: - - '' - then: - - addLabel: - label: Billing - - if: - - includesModifiedFiles: - files: - - specification/cdn/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - CDN - - if: - - includesModifiedFiles: - files: - - specification/cognitiveservices/ - excludedFiles: - - '' - then: - - addLabel: - label: Cognitive Services - - if: - - includesModifiedFiles: - files: - - specification/cognitiveservices/data-plane/Language/ - excludedFiles: - - '' - then: - - addLabel: - label: Cognitive - Language - - if: - - includesModifiedFiles: - files: - - specification/compute/ - excludedFiles: - - '' - then: - - addLabel: - label: Compute - - if: - - includesModifiedFiles: - files: - - specification/containerinstance/ - excludedFiles: - - '' - then: - - addLabel: - label: Container Instances - - if: - - includesModifiedFiles: - files: - - specification/containerregistry/ - excludedFiles: - - '' - then: - - addLabel: - label: Container Registry - - if: - - includesModifiedFiles: - files: - - specification/containerservice/ - excludedFiles: - - '' - then: - - addLabel: - label: Container Service - - if: - - includesModifiedFiles: - files: - - specification/cosmos-db/ - excludedFiles: - - '' - then: - - addLabel: - label: Cosmos - - if: - - includesModifiedFiles: - files: - - specification/customer-insights/ - excludedFiles: - - '' - then: - - addLabel: - label: Customer Insights - - if: - - includesModifiedFiles: - files: - - specification/datafactory/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Factory - - if: - - includesModifiedFiles: - files: - - specification/datalake-analytics/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Lake Analytics - - if: - - includesModifiedFiles: - files: - - specification/datalake-store/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Lake Store - - if: - - includesModifiedFiles: - files: - - specification/datamigration/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Migration - - if: - - includesModifiedFiles: - files: - - specification/deviceupdate/data-plane/ - excludedFiles: - - '' - then: - - addLabel: - label: Device Update - - if: - - includesModifiedFiles: - files: - - specification/devtestlabs/ - excludedFiles: - - '' - then: - - addLabel: - label: Devtestlab - - if: - - includesModifiedFiles: - files: - - specification/dns/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - DNS - - if: - - includesModifiedFiles: - files: - - specification/eventgrid/ - excludedFiles: - - '' - then: - - addLabel: - label: Event Grid - - if: - - includesModifiedFiles: - files: - - specification/eventhub/ - excludedFiles: - - '' - then: - - addLabel: - label: Event Hubs - - if: - - includesModifiedFiles: - files: - - specification/hdinsight/ - excludedFiles: - - '' - then: - - addLabel: - label: HDInsight - - if: - - includesModifiedFiles: - files: - - specification/intune/ - excludedFiles: - - '' - then: - - addLabel: - label: Intune - - if: - - includesModifiedFiles: - files: - - specification/iothub/ - excludedFiles: - - '' - then: - - addLabel: - label: IotHub - - if: - - includesModifiedFiles: - files: - - specification/keyvault/ - excludedFiles: - - '' - then: - - addLabel: - label: KeyVault - - if: - - includesModifiedFiles: - files: - - specification/logic/ - excludedFiles: - - '' - then: - - addLabel: - label: Logic App - - if: - - includesModifiedFiles: - files: - - specification/machinelearning/ - excludedFiles: - - '' - then: - - addLabel: - label: Machine Learning - - if: - - includesModifiedFiles: - files: - - specification/machinelearningcompute/ - excludedFiles: - - '' - then: - - addLabel: - label: Machine Learning Compute - - if: - - includesModifiedFiles: - files: - - specification/mediaservices/ - excludedFiles: - - '' - then: - - addLabel: - label: Media Services - - if: - - includesModifiedFiles: - files: - - specification/mobileengagement/ - excludedFiles: - - '' - then: - - addLabel: - label: Mobile Engagement - - if: - - includesModifiedFiles: - files: - - specification/monitor/ - excludedFiles: - - '' - then: - - addLabel: - label: Monitor - - if: - - includesModifiedFiles: - files: - - specification/mysql/ - excludedFiles: - - '' - then: - - addLabel: - label: MySQL - - if: - - includesModifiedFiles: - files: - - specification/network/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - - if: - - includesModifiedFiles: - files: - - specification/notificationhubs/ - excludedFiles: - - '' - then: - - addLabel: - label: Notification Hub - - if: - - includesModifiedFiles: - files: - - specification/operationalinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: Monitor - Operational Insights - - if: - - includesModifiedFiles: - files: - - specification/operationsmanagement/ - excludedFiles: - - '' - then: - - addLabel: - label: Operations Management - - if: - - includesModifiedFiles: - files: - - specification/peering/ - excludedFiles: - - '' - then: - - addLabel: - label: Peering - - if: - - includesModifiedFiles: - files: - - specification/policyinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: Policy Insights - - if: - - includesModifiedFiles: - files: - - specification/postgresql/ - excludedFiles: - - '' - then: - - addLabel: - label: PostgreSQL - - if: - - includesModifiedFiles: - files: - - specification/provisioningservices/ - excludedFiles: - - '' - then: - - addLabel: - label: PostgreSQL - - if: - - includesModifiedFiles: - files: - - specification/recoveryservices/ - excludedFiles: - - '' - then: - - addLabel: - label: RecoveryServices - - if: - - includesModifiedFiles: - files: - - specification/recoveryservicesbackup/ - excludedFiles: - - '' - then: - - addLabel: - label: Recovery Services Backup - - if: - - includesModifiedFiles: - files: - - specification/recoveryservicessiterecovery/ - excludedFiles: - - '' - then: - - addLabel: - label: Recovery Services Site-Recovery - - if: - - includesModifiedFiles: - files: - - specification/redis/ - excludedFiles: - - '' - then: - - addLabel: - label: Redis Cache - - if: - - includesModifiedFiles: - files: - - specification/relay/ - excludedFiles: - - '' - then: - - addLabel: - label: Relay - - if: - - includesModifiedFiles: - files: - - specification/scheduler/ - excludedFiles: - - '' - then: - - addLabel: - label: Scheduler - - if: - - includesModifiedFiles: - files: - - specification/search/data-plane/ - excludedFiles: - - '' - then: - - addLabel: - label: Search - - if: - - includesModifiedFiles: - files: - - specification/search/resource-manager/ - excludedFiles: - - '' - then: - - addLabel: - label: Search - - if: - - includesModifiedFiles: - files: - - specification/service-map/ - excludedFiles: - - '' - then: - - addLabel: - label: Service Map - - if: - - includesModifiedFiles: - files: - - specification/servicebus/ - excludedFiles: - - '' - then: - - addLabel: - label: Service Bus - - if: - - includesModifiedFiles: - files: - - specification/servicefabric/ - excludedFiles: - - '' - then: - - addLabel: - label: Service Fabric - - if: - - includesModifiedFiles: - files: - - specification/sql/ - excludedFiles: - - '' - then: - - addLabel: - label: SQL - - if: - - includesModifiedFiles: - files: - - specification/storage/ - excludedFiles: - - '' - then: - - addLabel: - label: Storage - - if: - - includesModifiedFiles: - files: - - specification/storageimportexport/ - excludedFiles: - - '' - then: - - addLabel: - label: Import Export - - if: - - includesModifiedFiles: - files: - - specification/storagesync/ - excludedFiles: - - '' - then: - - addLabel: - label: StorageSync - - if: - - includesModifiedFiles: - files: - - specification/storsimple8000series/ - excludedFiles: - - '' - then: - - addLabel: - label: Storsimple - - if: - - includesModifiedFiles: - files: - - specification/streamanalytics/ - excludedFiles: - - '' - then: - - addLabel: - label: Stream Analytics - - if: - - includesModifiedFiles: - files: - - specification/subscriptions/ - excludedFiles: - - '' - then: - - addLabel: - label: Subscription - - if: - - includesModifiedFiles: - files: - - specification/synapse/ - excludedFiles: - - '' - then: - - addLabel: - label: Synapses - - if: - - includesModifiedFiles: - files: - - specification/loadtestservice/ - excludedFiles: - - '' - then: - - addLabel: - label: Load Test Service - - if: - - includesModifiedFiles: - files: - - specification/maps/ - excludedFiles: - - '' - then: - - addLabel: - label: Maps - - if: - - includesModifiedFiles: - files: - - specification/purview/ - excludedFiles: - - '' - then: - - addLabel: - label: Purview - - if: - - includesModifiedFiles: - files: - - specification/timeseriesinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: TimeseriesInsights - - if: - - includesModifiedFiles: - files: - - specification/trafficmanager/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - Traffic Manager - - if: - - includesModifiedFiles: - files: - - specification/web/ - excludedFiles: - - '' - then: - - addLabel: - label: Web Apps - - if: - - includesModifiedFiles: - files: - - profile/ - excludedFiles: - - '' - then: - - addLabel: - label: Profile - - if: - - includesModifiedFiles: - files: - - specification/hybridcompute/resource-manager/ - - specification/connectedvmware/resource-manager/ - - specification/azurestackhci/resource-manager/ - - specification/scvmm/resource-manager/ - then: - - addLabel: - label: ArcReview - description: - - if: - - payloadType: Pull_Request - then: - - if: - - includesModifiedFiles: - files: - - dev/cognitiveservices/data-plane/Language/ - excludedFiles: - - '' - then: - - addLabel: - label: Cognitive Services - - if: - - includesModifiedFiles: - files: - - specification/analysisservices/ - excludedFiles: - - '' - then: - - addLabel: - label: Analysis Services - - if: - - includesModifiedFiles: - files: - - specification/alertsmanagement/ - excludedFiles: - - '' - then: - - addLabel: - label: Alerts Management - - if: - - includesModifiedFiles: - files: - - specification/apimanagement/ - excludedFiles: - - '' - then: - - addLabel: - label: API Management - - if: - - includesModifiedFiles: - files: - - specification/applicationinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: Insights - - if: - - includesModifiedFiles: - files: - - specification/applicationinsights/data-plane/Monitor.Exporters/ - excludedFiles: - - '' - then: - - addLabel: - label: Monitor - Exporter - - if: - - includesModifiedFiles: - files: - - specification/authorization/ - excludedFiles: - - '' - then: - - addLabel: - label: Authorization - - if: - - includesModifiedFiles: - files: - - specification/automation/ - excludedFiles: - - '' - then: - - addLabel: - label: Automation - - if: - - includesModifiedFiles: - files: - - specification/batch/ - excludedFiles: - - '' - then: - - addLabel: - label: Batch - - if: - - includesModifiedFiles: - files: - - specification/batchai/ - excludedFiles: - - '' - then: - - addLabel: - label: BatchAI - - if: - - includesModifiedFiles: - files: - - specification/billing/ - excludedFiles: - - '' - then: - - addLabel: - label: Billing - - if: - - includesModifiedFiles: - files: - - specification/cdn/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - CDN - - if: - - includesModifiedFiles: - files: - - specification/cognitiveservices/ - excludedFiles: - - '' - then: - - addLabel: - label: Cognitive Services - - if: - - includesModifiedFiles: - files: - - specification/cognitiveservices/data-plane/Language/ - excludedFiles: - - '' - then: - - addLabel: - label: Cognitive - Language - - if: - - includesModifiedFiles: - files: - - specification/compute/ - excludedFiles: - - '' - then: - - addLabel: - label: Compute - - if: - - includesModifiedFiles: - files: - - specification/containerinstance/ - excludedFiles: - - '' - then: - - addLabel: - label: Container Instances - - if: - - includesModifiedFiles: - files: - - specification/containerregistry/ - excludedFiles: - - '' - then: - - addLabel: - label: Container Registry - - if: - - includesModifiedFiles: - files: - - specification/containerservice/ - excludedFiles: - - '' - then: - - addLabel: - label: Container Service - - if: - - includesModifiedFiles: - files: - - specification/cosmos-db/ - excludedFiles: - - '' - then: - - addLabel: - label: Cosmos - - if: - - includesModifiedFiles: - files: - - specification/customer-insights/ - excludedFiles: - - '' - then: - - addLabel: - label: Customer Insights - - if: - - includesModifiedFiles: - files: - - specification/datafactory/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Factory - - if: - - includesModifiedFiles: - files: - - specification/datalake-analytics/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Lake Analytics - - if: - - includesModifiedFiles: - files: - - specification/datalake-store/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Lake Store - - if: - - includesModifiedFiles: - files: - - specification/datamigration/ - excludedFiles: - - '' - then: - - addLabel: - label: Data Migration - - if: - - includesModifiedFiles: - files: - - specification/deviceupdate/data-plane/ - excludedFiles: - - '' - then: - - addLabel: - label: Device Update - - if: - - includesModifiedFiles: - files: - - specification/devtestlabs/ - excludedFiles: - - '' - then: - - addLabel: - label: Devtestlab - - if: - - includesModifiedFiles: - files: - - specification/dns/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - DNS - - if: - - includesModifiedFiles: - files: - - specification/eventgrid/ - excludedFiles: - - '' - then: - - addLabel: - label: Event Grid - - if: - - includesModifiedFiles: - files: - - specification/eventhub/ - excludedFiles: - - '' - then: - - addLabel: - label: Event Hubs - - if: - - includesModifiedFiles: - files: - - specification/hdinsight/ - excludedFiles: - - '' - then: - - addLabel: - label: HDInsight - - if: - - includesModifiedFiles: - files: - - specification/intune/ - excludedFiles: - - '' - then: - - addLabel: - label: Intune - - if: - - includesModifiedFiles: - files: - - specification/iothub/ - excludedFiles: - - '' - then: - - addLabel: - label: IotHub - - if: - - includesModifiedFiles: - files: - - specification/keyvault/ - excludedFiles: - - '' - then: - - addLabel: - label: KeyVault - - if: - - includesModifiedFiles: - files: - - specification/logic/ - excludedFiles: - - '' - then: - - addLabel: - label: Logic App - - if: - - includesModifiedFiles: - files: - - specification/machinelearning/ - excludedFiles: - - '' - then: - - addLabel: - label: Machine Learning - - if: - - includesModifiedFiles: - files: - - specification/machinelearningcompute/ - excludedFiles: - - '' - then: - - addLabel: - label: Machine Learning Compute - - if: - - includesModifiedFiles: - files: - - specification/mediaservices/ - excludedFiles: - - '' - then: - - addLabel: - label: Media Services - - if: - - includesModifiedFiles: - files: - - specification/mobileengagement/ - excludedFiles: - - '' - then: - - addLabel: - label: Mobile Engagement - - if: - - includesModifiedFiles: - files: - - specification/monitor/ - excludedFiles: - - '' - then: - - addLabel: - label: Monitor - - if: - - includesModifiedFiles: - files: - - specification/mysql/ - excludedFiles: - - '' - then: - - addLabel: - label: MySQL - - if: - - includesModifiedFiles: - files: - - specification/network/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - - if: - - includesModifiedFiles: - files: - - specification/notificationhubs/ - excludedFiles: - - '' - then: - - addLabel: - label: Notification Hub - - if: - - includesModifiedFiles: - files: - - specification/operationalinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: Monitor - Operational Insights - - if: - - includesModifiedFiles: - files: - - specification/operationsmanagement/ - excludedFiles: - - '' - then: - - addLabel: - label: Operations Management - - if: - - includesModifiedFiles: - files: - - specification/peering/ - excludedFiles: - - '' - then: - - addLabel: - label: Peering - - if: - - includesModifiedFiles: - files: - - specification/policyinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: Policy Insights - - if: - - includesModifiedFiles: - files: - - specification/postgresql/ - excludedFiles: - - '' - then: - - addLabel: - label: PostgreSQL - - if: - - includesModifiedFiles: - files: - - specification/provisioningservices/ - excludedFiles: - - '' - then: - - addLabel: - label: PostgreSQL - - if: - - includesModifiedFiles: - files: - - specification/recoveryservices/ - excludedFiles: - - '' - then: - - addLabel: - label: RecoveryServices - - if: - - includesModifiedFiles: - files: - - specification/recoveryservicesbackup/ - excludedFiles: - - '' - then: - - addLabel: - label: Recovery Services Backup - - if: - - includesModifiedFiles: - files: - - specification/recoveryservicessiterecovery/ - excludedFiles: - - '' - then: - - addLabel: - label: Recovery Services Site-Recovery - - if: - - includesModifiedFiles: - files: - - specification/redis/ - excludedFiles: - - '' - then: - - addLabel: - label: Redis Cache - - if: - - includesModifiedFiles: - files: - - specification/relay/ - excludedFiles: - - '' - then: - - addLabel: - label: Relay - - if: - - includesModifiedFiles: - files: - - specification/scheduler/ - excludedFiles: - - '' - then: - - addLabel: - label: Scheduler - - if: - - includesModifiedFiles: - files: - - specification/search/data-plane/ - excludedFiles: - - '' - then: - - addLabel: - label: Search - - if: - - includesModifiedFiles: - files: - - specification/search/resource-manager/ - excludedFiles: - - '' - then: - - addLabel: - label: Search - - if: - - includesModifiedFiles: - files: - - specification/service-map/ - excludedFiles: - - '' - then: - - addLabel: - label: Service Map - - if: - - includesModifiedFiles: - files: - - specification/servicebus/ - excludedFiles: - - '' - then: - - addLabel: - label: Service Bus - - if: - - includesModifiedFiles: - files: - - specification/servicefabric/ - excludedFiles: - - '' - then: - - addLabel: - label: Service Fabric - - if: - - includesModifiedFiles: - files: - - specification/sql/ - excludedFiles: - - '' - then: - - addLabel: - label: SQL - - if: - - includesModifiedFiles: - files: - - specification/storage/ - excludedFiles: - - '' - then: - - addLabel: - label: Storage - - if: - - includesModifiedFiles: - files: - - specification/storageimportexport/ - excludedFiles: - - '' - then: - - addLabel: - label: Import Export - - if: - - includesModifiedFiles: - files: - - specification/storagesync/ - excludedFiles: - - '' - then: - - addLabel: - label: StorageSync - - if: - - includesModifiedFiles: - files: - - specification/storsimple8000series/ - excludedFiles: - - '' - then: - - addLabel: - label: Storsimple - - if: - - includesModifiedFiles: - files: - - specification/streamanalytics/ - excludedFiles: - - '' - then: - - addLabel: - label: Stream Analytics - - if: - - includesModifiedFiles: - files: - - specification/subscriptions/ - excludedFiles: - - '' - then: - - addLabel: - label: Subscription - - if: - - includesModifiedFiles: - files: - - specification/synapse/ - excludedFiles: - - '' - then: - - addLabel: - label: Synapses - - if: - - includesModifiedFiles: - files: - - specification/timeseriesinsights/ - excludedFiles: - - '' - then: - - addLabel: - label: TimeseriesInsights - - if: - - includesModifiedFiles: - files: - - specification/trafficmanager/ - excludedFiles: - - '' - then: - - addLabel: - label: Network - Traffic Manager - - if: - - includesModifiedFiles: - files: - - specification/web/ - excludedFiles: - - '' - then: - - addLabel: - label: Web Apps - - if: - - includesModifiedFiles: - files: - - profile/ - excludedFiles: - - '' - then: - - addLabel: - label: Profile - description: - - if: - - payloadType: Issues - - hasLabel: - label: customer-reported - - hasLabel: - label: needs-triage - - isAction: - action: Labeled - then: - - addLabel: - label: CXP Attention - description: -onFailure: -onSuccess: +id: +name: GitOps.PullRequestIssueManagement +description: GitOps.PullRequestIssueManagement primitive +owner: +resource: repository +disabled: false +where: +configuration: + resourceManagementConfiguration: + scheduledSearches: + - description: + frequencies: + - daily: + time: 1:0 + filters: + - isIssue + - isOpen + - hasLabel: + label: needs-author-feedback + - hasLabel: + label: no-recent-activity + - noActivitySince: + days: 14 + actions: + - closeIssue + - description: + frequencies: + - hourly: + hour: 6 + filters: + - isIssue + - isOpen + - hasLabel: + label: needs-author-feedback + - noActivitySince: + days: 7 + - isNotLabeledWith: + label: no-recent-activity + actions: + - addLabel: + label: no-recent-activity + - addReply: + reply: Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next **7 days**. If we don't hear back from you within **14 days** of this comment the issue will be automatically closed. Thank you! + - description: + frequencies: + - weekday: + day: Monday + time: 0:0 + filters: + - noActivitySince: + days: 14 + - isOpen + - isNotLabeledWith: + label: no-recent-activity + - isNotLabeledWith: + label: customer-reported + - isPullRequest + - isNotDraftPullRequest + actions: + - addReply: + reply: 'Hi, @${issueAuthor}. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove `no-recent-activity` label. ' + - addLabel: + label: no-recent-activity + - description: + frequencies: + - daily: + time: 13:0 + filters: + - isOpen + - hasLabel: + label: no-recent-activity + - noActivitySince: + days: 14 + - isNotLabeledWith: + label: customer-reported + actions: + - closeIssue + - addReply: + reply: Hi, @${issueAuthor}. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. + eventResponderTasks: + - if: + - payloadType: Issue_Comment + - isAction: + action: Created + - isActivitySender: + issueAuthor: True + - hasLabel: + label: needs-author-feedback + - isOpen + then: + - addLabel: + label: needs-team-attention + - removeLabel: + label: needs-author-feedback + description: + - if: + - payloadType: Issues + - not: + isAction: + action: Closed + - hasLabel: + label: no-recent-activity + then: + - removeLabel: + label: no-recent-activity + description: + - if: + - payloadType: Issue_Comment + - hasLabel: + label: no-recent-activity + then: + - removeLabel: + label: no-recent-activity + description: + - if: + - payloadType: Issues + - isAction: + action: Labeled + - hasLabel: + label: needs-triage + - not: + labelAdded: + label: needs-triage + then: + - removeLabel: + label: needs-triage + description: + - if: + - payloadType: Issues + - isOpen + - hasLabel: + label: customer-reported + - labelRemoved: + label: Service Attention + then: + - addLabel: + label: needs-team-triage + description: + - if: + - payloadType: Issues + - isAction: + action: Opened + - and: + - not: + activitySenderHasPermission: + permission: Write + - not: + activitySenderHasAssociation: + association: Member + - not: + activitySenderHasAssociation: + association: Collaborator + - not: + activitySenderHasPermission: + permission: Admin + then: + - addLabel: + label: question + description: + - if: + - or: + - payloadType: Issues + - isAction: + action: Opened + then: + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: AKS + then: + - mentionUsers: + mentionees: + - Azure/aks-pm + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Alerts Management + then: + - mentionUsers: + mentionees: + - liadtal + - yairgil + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM + then: + - mentionUsers: + mentionees: + - josephkwchan + - jennyhunter-msft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM - Templates + then: + - mentionUsers: + mentionees: + - Azure/deployments-owners + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM - Tags + then: + - mentionUsers: + mentionees: + - rthorn17 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM - Core + then: + - mentionUsers: + mentionees: + - josephkwchan + - jennyhunter-msft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM - Managed Applications + then: + - mentionUsers: + mentionees: + - MSEvanhi + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM - Service Catalog + then: + - mentionUsers: + mentionees: + - MSEvanhi + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARM - RBAC + then: + - mentionUsers: + mentionees: + - LizMS + - cbrooksmsft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Advisor + then: + - mentionUsers: + mentionees: + - mojayara + - Prasanna-Padmanabhan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Analysis Services + then: + - mentionUsers: + mentionees: + - athipp + - taiwu + - minghan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: API Management + then: + - mentionUsers: + mentionees: + - adrianhall + - KedarJoshi + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Application Insights + then: + - mentionUsers: + mentionees: + - azmonapplicationinsights + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: App Services + then: + - mentionUsers: + mentionees: + - antcp + - AzureAppServiceCLI + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: App Configuration + then: + - mentionUsers: + mentionees: + - jiayi11 + - avanigupta + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ARO + then: + - mentionUsers: + mentionees: + - mjudeikis + - jim-minter + - julienstroheker + - amanohar + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Attestation + then: + - mentionUsers: + mentionees: + - anilba06 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Authorization + then: + - mentionUsers: + mentionees: + - darshanhs90 + - AshishGargMicrosoft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Automation + then: + - mentionUsers: + mentionees: + - jaspkaur28 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: AVS + then: + - mentionUsers: + mentionees: + - divka78 + - amitchat + - aishu + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Azure Stack + then: + - mentionUsers: + mentionees: + - sijuman + - sarathys + - bganapa + - rakku-ms + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Batch + then: + - mentionUsers: + mentionees: + - cRui861 + - paterasMSFT + - gingi + - dpwatrous + - mksuni + - bgklein + - mscurrell + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: BatchAI + then: + - mentionUsers: + mentionees: + - matthchr + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Billing + then: + - mentionUsers: + mentionees: + - cabbpt + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Blueprint + then: + - mentionUsers: + mentionees: + - alex-frankel + - filizt + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Bot Service + then: + - mentionUsers: + mentionees: + - sgellock + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cloud Shell + then: + - mentionUsers: + mentionees: + - maertendMSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Text Analytics + then: + - mentionUsers: + mentionees: + - assafi + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Form Recognizer + then: + - mentionUsers: + mentionees: + - ctstone + - anrothMSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Anomaly Detector + then: + - mentionUsers: + mentionees: + - yingqunpku + - bowgong + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Custom Vision + then: + - mentionUsers: + mentionees: + - areddish + - tburns10 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Computer Vision + then: + - mentionUsers: + mentionees: + - ryogok + - TFR258 + - tburns10 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Face + then: + - mentionUsers: + mentionees: + - JinyuID + - dipidoo + - SteveMSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - QnA Maker + then: + - mentionUsers: + mentionees: + - bingisbestest + - nerajput1607 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Translator + then: + - mentionUsers: + mentionees: + - swmachan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Speech + then: + - mentionUsers: + mentionees: + - robch + - oscholz + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - LUIS + then: + - mentionUsers: + mentionees: + - cahann + - kayousef + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Content Moderator + then: + - mentionUsers: + mentionees: + - swiftarrow11 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Personalizer + then: + - mentionUsers: + mentionees: + - dwaijam + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Immersive Reader + then: + - mentionUsers: + mentionees: + - metanMSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Ink Recognizer + then: + - mentionUsers: + mentionees: + - olduroja + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Bing + then: + - mentionUsers: + mentionees: + - jaggerbodas-ms + - arwong + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cognitive - Mgmt + then: + - mentionUsers: + mentionees: + - yangyuan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Commerce + then: + - mentionUsers: + mentionees: + - ms-premp + - qiaozha + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute + then: + - mentionUsers: + mentionees: + - Drewm3 + - TravisCragg-MSFT + - nikhilpatel909 + - sandeepraichura + - hilaryw29 + - GabstaMSFT + - ramankumarlive + - ushnaarshadkhan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute - Extensions + then: + - mentionUsers: + mentionees: + - TravisCragg-MSFT + - GabstaMSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute - Images + then: + - mentionUsers: + mentionees: + - TravisCragg-MSFT + - sandeepraichura + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute - Managed Disks + then: + - mentionUsers: + mentionees: + - TravisCragg-MSFT + - ramankumarlive + - ushnaarshadkhan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute - RDFE + then: + - mentionUsers: + mentionees: + - Drewm3 + - TravisCragg-MSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute - VM + then: + - mentionUsers: + mentionees: + - Drewm3 + - TravisCragg-MSFT + - nikhilpatel909 + - sandeepraichura + - hilaryw29 + - GabstaMSFT + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Compute - VMSS + then: + - mentionUsers: + mentionees: + - TravisCragg-MSFT + - hilaryw29 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Connected Kubernetes + then: + - mentionUsers: + mentionees: + - akashkeshari + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Container Instances + then: + - mentionUsers: + mentionees: + - macolso + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Container Registry + then: + - mentionUsers: + mentionees: + - toddysm + - luisdlp + - northtyphoon + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Container Service + then: + - mentionUsers: + mentionees: + - qike-ms + - jwilder + - thomas1206 + - seanmck + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cosmos + then: + - mentionUsers: + mentionees: + - pjohari-ms + - MehaKaushik + - zfoster + - kushagraThapar + - simorenoh + - simplynaveen20 + - abinav2307 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Customer Insights + then: + - mentionUsers: + mentionees: + - shefymk + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Custom Providers + then: + - mentionUsers: + mentionees: + - manoharp + - MSEvanhi + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: CycleCloud + then: + - mentionUsers: + mentionees: + - adriankjohnson + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Bricks + then: + - mentionUsers: + mentionees: + - arindamc + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: DataBox + then: + - mentionUsers: + mentionees: + - tmvishwajit + - matdickson + - manuaery + - madhurinms + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: DataBox Edge + then: + - mentionUsers: + mentionees: + - a-t-mason + - ganzee + - manuaery + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Catalog + then: + - mentionUsers: + mentionees: + - ingave + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Factory + then: + - mentionUsers: + mentionees: + - Jingshu923 + - zhangyd2015 + - Frey-Wang + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Lake + then: + - mentionUsers: + mentionees: + - sumantmehtams + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Lake Storage Gen1 + then: + - mentionUsers: + mentionees: + - sumantmehtams + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Lake Storage Gen2 + then: + - mentionUsers: + mentionees: + - sumantmehtams + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Lake Analytics + then: + - mentionUsers: + mentionees: + - idear1203 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Lake Store + then: + - mentionUsers: + mentionees: + - sumantmehtams + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Migration + then: + - mentionUsers: + mentionees: + - radjaram + - kavitham10 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Data Share + then: + - mentionUsers: + mentionees: + - raedJarrar + - jifems + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: DevOps + then: + - mentionUsers: + mentionees: + - v-anvashist + - V-hmusukula + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Dev Spaces + then: + - mentionUsers: + mentionees: + - yuzorMa + - johnsta + - greenie-msft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Devtestlab + then: + - mentionUsers: + mentionees: + - Tanmayeekamath + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Device Provisioning Service + then: + - mentionUsers: + mentionees: + - nberdy + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Digital Twins + then: + - mentionUsers: + mentionees: + - sourabhguha + - inesk-vt + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Event Grid + then: + - mentionUsers: + mentionees: + - jfggdl + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Event Hubs + then: + - mentionUsers: + mentionees: + - Saglodha + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Functions + then: + - mentionUsers: + mentionees: + - Stefanus Hinardi + - Francisco-Gamino + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Graph.Microsoft + then: + - mentionUsers: + mentionees: + - dkershaw10 + - baywet + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Guest Configuration + then: + - mentionUsers: + mentionees: + - mgreenegit + - vivlingaiah + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: HDInsight + then: + - mentionUsers: + mentionees: + - aim-for-better + - idear1203 + - deshriva + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: HPC Cache + then: + - mentionUsers: + mentionees: + - romahamu + - omzevall + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Import Export + then: + - mentionUsers: + mentionees: + - madhurinms + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: KeyVault + then: + - mentionUsers: + mentionees: + - RandalliLama + - schaabs + - jlichwa + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Kubernetes Configuration + then: + - mentionUsers: + mentionees: + - NarayanThiru + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Azure Data Explorer + then: + - mentionUsers: + mentionees: + - ilayrn + - orhasban + - zoharHenMicrosoft + - sagivf + - Aviv-Yaniv + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Lab Services + then: + - mentionUsers: + mentionees: + - Tanmayeekamath + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Logic App + then: + - mentionUsers: + mentionees: + - Azure/azure-logicapps-team + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: LOUIS + then: + - mentionUsers: + mentionees: + - minamnmik + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Machine Learning + then: + - mentionUsers: + mentionees: + - azureml-github + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Machine Learning Compute + then: + - mentionUsers: + mentionees: + - azureml-github + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Machine Learning Experimentation + then: + - mentionUsers: + mentionees: + - aashishb + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Managed Services + then: + - mentionUsers: + mentionees: + - Lighthouse-Azure + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: MariaDB + then: + - mentionUsers: + mentionees: + - ambhatna + - savjani + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Marketplace Ordering + then: + - mentionUsers: + mentionees: + - prbansa + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Media Services + then: + - mentionUsers: + mentionees: + - akucer + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Migrate + then: + - mentionUsers: + mentionees: + - shijojoy + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Mobile Engagement + then: + - mentionUsers: + mentionees: + - kpiteira + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor + then: + - mentionUsers: + mentionees: + - SameergMS + - dadunl + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - Autoscale + then: + - mentionUsers: + mentionees: + - AzMonEssential + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - ActivityLogs + then: + - mentionUsers: + mentionees: + - AzMonEssential + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - Metrics + then: + - mentionUsers: + mentionees: + - AzMonEssential + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - Diagnostic Settings + then: + - mentionUsers: + mentionees: + - AzMonEssential + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - Alerts + then: + - mentionUsers: + mentionees: + - AzmonAlerts + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - ActionGroups + then: + - mentionUsers: + mentionees: + - AzmonActionG + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - LogAnalytics + then: + - mentionUsers: + mentionees: + - AzmonLogA + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Monitor - ApplicationInsights + then: + - mentionUsers: + mentionees: + - azmonapplicationinsights + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: MySQL + then: + - mentionUsers: + mentionees: + - ambhatna + - savjani + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network + then: + - mentionUsers: + mentionees: + - aznetsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Application Gateway + then: + - mentionUsers: + mentionees: + - appgwsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - CDN + then: + - mentionUsers: + mentionees: + - t-bzhan + - gxue + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - DDOS Protection + then: + - mentionUsers: + mentionees: + - ddossuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - ExpressRoute + then: + - mentionUsers: + mentionees: + - exrsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Firewall + then: + - mentionUsers: + mentionees: + - fwsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Front Door + then: + - mentionUsers: + mentionees: + - cdnfdsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Load Balancer + then: + - mentionUsers: + mentionees: + - slbsupportgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Virtual Network NAT + then: + - mentionUsers: + mentionees: + - vnetsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Network Watcher + then: + - mentionUsers: + mentionees: + - netwatchsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - DNS + then: + - mentionUsers: + mentionees: + - dnssuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Traffic Manager + then: + - mentionUsers: + mentionees: + - tmsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - VPN Gateway + then: + - mentionUsers: + mentionees: + - vpngwsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Notification Hub + then: + - mentionUsers: + mentionees: + - tjsomasundaram + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Operational Insights + then: + - mentionUsers: + mentionees: + - AzmonLogA + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Policy + then: + - mentionUsers: + mentionees: + - aperezcloud + - kenieva + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Policy Insights + then: + - mentionUsers: + mentionees: + - kenieva + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: PostgreSQL + then: + - mentionUsers: + mentionees: + - sunilagarwal + - lfittl-msft + - sr-msft + - niklarin + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Recovery Services Backup + then: + - mentionUsers: + mentionees: + - pvrk + - adityabalaji-msft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Recovery Services Site-Recovery + then: + - mentionUsers: + mentionees: + - Sharmistha-Rai + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Redis Cache + then: + - mentionUsers: + mentionees: + - yegu-ms + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Relay + then: + - mentionUsers: + mentionees: + - jfggdl + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Reservations + then: + - mentionUsers: + mentionees: + - Rkapso + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Resource Authorization + then: + - mentionUsers: + mentionees: + - darshanhs90 + - AshishGargMicrosoft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Resource Graph + then: + - mentionUsers: + mentionees: + - chiragg4u + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Resource Health + then: + - mentionUsers: + mentionees: + - stephbaron + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Scheduler + then: + - mentionUsers: + mentionees: + - derek1ee + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Search + then: + - mentionUsers: + mentionees: + - bleroy + - tjacobhi + - markheff + - miwelsh + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Security + then: + - mentionUsers: + mentionees: + - chlahav + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Service Bus + then: + - mentionUsers: + mentionees: + - Saglodha + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Service Fabric + then: + - mentionUsers: + mentionees: + - QingChenmsft + - vaishnavk + - juhacket + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Schema Registry + then: + - mentionUsers: + mentionees: + - arerlend + - alzimmermsft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SignalR + then: + - mentionUsers: + mentionees: + - sffamily + - chenkennt + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL - VM + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL - Backup & Restore + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL - Data Security + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL - Elastic Jobs + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL - Managed Instance + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SQL - Replication & Failover + then: + - mentionUsers: + mentionees: + - azureSQLGitHub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Storage + then: + - mentionUsers: + mentionees: + - xgithubtriage + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Storsimple + then: + - mentionUsers: + mentionees: + - anoobbacker + - ganzee + - manuaery + - patelkunal + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Stream Analytics + then: + - mentionUsers: + mentionees: + - atpham256 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Subscription + then: + - mentionUsers: + mentionees: + - anuragdalmia + - shilpigautam + - ramaganesan-rg + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Support + then: + - mentionUsers: + mentionees: + - shahbj79 + - mit2nil + - aygoya + - ganganarayanan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Synapse + then: + - mentionUsers: + mentionees: + - wonner + - yanjungao718 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Tables + then: + - mentionUsers: + mentionees: + - klaaslanghout + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: TimeseriesInsights + then: + - mentionUsers: + mentionees: + - Shipra1Mishra + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: vFXT + then: + - mentionUsers: + mentionees: + - zhusijia26 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Web Apps + then: + - mentionUsers: + mentionees: + - AzureAppServiceCLI + - antcp + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Virtual Network + then: + - mentionUsers: + mentionees: + - vnetsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Virtual WAN + then: + - mentionUsers: + mentionees: + - vwansuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Network Virtual Appliance + then: + - mentionUsers: + mentionees: + - nvasuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Bastion + then: + - mentionUsers: + mentionees: + - bastionsuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: IoT/CLI + then: + - mentionUsers: + mentionees: + - Azure/azure-iot-cli-triage + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Azure.Spring - Cosmos + then: + - mentionUsers: + mentionees: + - kushagraThapur + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Network - Private Link + then: + - mentionUsers: + mentionees: + - privlinksuppgithub + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Azure arc enabled servers + then: + - mentionUsers: + mentionees: + - rpsqrd + - edyoung + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: SecurityInsights + then: + - mentionUsers: + mentionees: + - amirkeren + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Azure Data Explorer + then: + - mentionUsers: + mentionees: + - Ilayrn + - orhasban + - zoharHenMicrosoft + - sagivf + - Aviv-Yaniv + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Communication + then: + - mentionUsers: + mentionees: + - acsdevx-msft + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cost Management and Consumption + then: + - mentionUsers: + mentionees: + - ccmaxpcrew + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: ML-AutoML + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - Aniththa + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Hyperdrive + then: + - mentionUsers: + mentionees: + - Aniththa + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Compute + then: + - mentionUsers: + mentionees: + - nishankgu + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Core UI + then: + - mentionUsers: + mentionees: + - abeomor + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Data4ML + then: + - mentionUsers: + mentionees: + - SturgeonMi + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Designer + then: + - mentionUsers: + mentionees: + - alainli0928 + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Data Labeling + then: + - mentionUsers: + mentionees: + - kvijaykannan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-Inference + then: + - mentionUsers: + mentionees: + - shivanissambare + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ML-MLOps + then: + - mentionUsers: + mentionees: + - lostmygithubaccount + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: ML-Pipelines + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - shbijlan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: ML-Responsible AI + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - minthigpen + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: ML-Reinforcement Learning + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - keijik + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: ML-Training + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - lostmygithubaccount + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: ML-Workspace Management + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - rastala + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Spring Cloud + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - ShichaoQiu + - yuwzho + - yucwan + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cost Management-Budget + then: + - mentionUsers: + mentionees: + - ccmaxpcrew + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Consumption-Budget + then: + - mentionUsers: + mentionees: + - ccmaxpcrew + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cost Management-Query + then: + - mentionUsers: + mentionees: + - ccmixpdevs + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Consumption-Query + then: + - mentionUsers: + mentionees: + - ccmixpdevs + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cost Management-Billing + then: + - mentionUsers: + mentionees: + - ccmbpxpcrew + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Consumption-Billing + then: + - mentionUsers: + mentionees: + - ccmbpxpcrew + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cost Management-UsageDetailsAndExport + then: + - mentionUsers: + mentionees: + - TiagoCrewGitHubIssues + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Consumption-UsageDetailsandExport + then: + - mentionUsers: + mentionees: + - TiagoCrewGitHubIssues + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Consumption- RIandShowBack + then: + - mentionUsers: + mentionees: + - ccmshowbackdevs + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Serial Console + then: + - mentionUsers: + mentionees: + - CraigWiand + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Monitor - Exporter + - hasLabel: + label: Service Attention + then: + - mentionUsers: + mentionees: + - cijothomas + - reyang + - rajkumar-rangaraj + - TimothyMothra + - vishweshbankwar + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: Cost Management-RIandShowBack + then: + - mentionUsers: + mentionees: + - ccmshowbackdevs + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + - if: + - hasLabel: + label: Service Attention + - hasLabel: + label: ContainerApp + then: + - mentionUsers: + mentionees: + - calvinsID + replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. + assignMentionees: False + description: + - if: + - payloadType: Pull_Request + - isAction: + action: Opened + - and: + - not: + activitySenderHasPermission: + permission: Write + - not: + activitySenderHasAssociation: + association: Member + - not: + activitySenderHasAssociation: + association: Collaborator + - not: + activitySenderHasPermission: + permission: Admin + then: + - addLabel: + label: customer-reported + - addReply: + reply: Thank you for your contribution ${issueAuthor}! We will review the pull request and get back to you soon. + description: + - if: + - payloadType: Pull_Request + - hasLabel: + label: no-recent-activity + - or: + - isAction: + action: Synchronize + - isAction: + action: Null + - isAction: + action: Unlabeled + - isAction: + action: Edited + - isAction: + action: Null + - isAction: + action: Reopened + - isAction: + action: Labeled + - isAction: + action: Edited + then: + - removeLabel: + label: no-recent-activity + description: + - if: + - payloadType: Pull_Request + then: + - if: + - includesModifiedFiles: + files: + - specification/apimanagement/resource-manager + then: + - addLabel: + label: API Management + - if: + - includesModifiedFiles: + files: + - specification/compute/resource-manager + then: + - addLabel: + label: Compute + - if: + - includesModifiedFiles: + files: + - specification/network/resource-manager + then: + - addLabel: + label: Network + - if: + - includesModifiedFiles: + files: + - specification/sql/resource-manager + then: + - addLabel: + label: SQL + - if: + - includesModifiedFiles: + files: + - specification/storage/resource-manager + then: + - addLabel: + label: Storage + - if: + - includesModifiedFiles: + files: + - specification/synapse + then: + - addLabel: + label: Synapses + description: + - if: + - payloadType: Issue_Comment + - hasLabel: + label: no-recent-activity + - isOpen + then: + - removeLabel: + label: no-recent-activity + description: + - if: + - payloadType: Issues + - isAction: + action: Opened + - and: + - not: + activitySenderHasPermission: + permission: Write + - not: + activitySenderHasAssociation: + association: Member + - not: + activitySenderHasAssociation: + association: Collaborator + - not: + activitySenderHasPermission: + permission: Admin + then: + - addLabel: + label: customer-reported + - addLabel: + label: question + description: + - if: + - payloadType: Pull_Request + then: + - if: + - includesModifiedFiles: + files: + - dev/cognitiveservices/data-plane/Language/ + excludedFiles: + - '' + then: + - addLabel: + label: Cognitive Services + - if: + - includesModifiedFiles: + files: + - specification/analysisservices/ + excludedFiles: + - '' + then: + - addLabel: + label: Analysis Services + - if: + - includesModifiedFiles: + files: + - specification/alertsmanagement/ + excludedFiles: + - '' + then: + - addLabel: + label: Alerts Management + - if: + - includesModifiedFiles: + files: + - specification/apimanagement/ + excludedFiles: + - '' + then: + - addLabel: + label: API Management + - if: + - includesModifiedFiles: + files: + - specification/applicationinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: Insights + - if: + - includesModifiedFiles: + files: + - specification/applicationinsights/data-plane/Monitor.Exporters/ + excludedFiles: + - '' + then: + - addLabel: + label: Monitor - Exporter + - if: + - includesModifiedFiles: + files: + - specification/authorization/ + excludedFiles: + - '' + then: + - addLabel: + label: Authorization + - if: + - includesModifiedFiles: + files: + - specification/automation/ + excludedFiles: + - '' + then: + - addLabel: + label: Automation + - if: + - includesModifiedFiles: + files: + - specification/batch/ + excludedFiles: + - '' + then: + - addLabel: + label: Batch + - if: + - includesModifiedFiles: + files: + - specification/batchai/ + excludedFiles: + - '' + then: + - addLabel: + label: BatchAI + - if: + - includesModifiedFiles: + files: + - specification/billing/ + excludedFiles: + - '' + then: + - addLabel: + label: Billing + - if: + - includesModifiedFiles: + files: + - specification/cdn/ + excludedFiles: + - '' + then: + - addLabel: + label: Network - CDN + - if: + - includesModifiedFiles: + files: + - specification/cognitiveservices/ + excludedFiles: + - '' + then: + - addLabel: + label: Cognitive Services + - if: + - includesModifiedFiles: + files: + - specification/cognitiveservices/data-plane/Language/ + excludedFiles: + - '' + then: + - addLabel: + label: Cognitive - Language + - if: + - includesModifiedFiles: + files: + - specification/compute/ + excludedFiles: + - '' + then: + - addLabel: + label: Compute + - if: + - includesModifiedFiles: + files: + - specification/containerinstance/ + excludedFiles: + - '' + then: + - addLabel: + label: Container Instances + - if: + - includesModifiedFiles: + files: + - specification/containerregistry/ + excludedFiles: + - '' + then: + - addLabel: + label: Container Registry + - if: + - includesModifiedFiles: + files: + - specification/containerservice/ + excludedFiles: + - '' + then: + - addLabel: + label: Container Service + - if: + - includesModifiedFiles: + files: + - specification/cosmos-db/ + excludedFiles: + - '' + then: + - addLabel: + label: Cosmos + - if: + - includesModifiedFiles: + files: + - specification/customer-insights/ + excludedFiles: + - '' + then: + - addLabel: + label: Customer Insights + - if: + - includesModifiedFiles: + files: + - specification/datafactory/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Factory + - if: + - includesModifiedFiles: + files: + - specification/datalake-analytics/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Lake Analytics + - if: + - includesModifiedFiles: + files: + - specification/datalake-store/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Lake Store + - if: + - includesModifiedFiles: + files: + - specification/datamigration/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Migration + - if: + - includesModifiedFiles: + files: + - specification/deviceupdate/data-plane/ + excludedFiles: + - '' + then: + - addLabel: + label: Device Update + - if: + - includesModifiedFiles: + files: + - specification/devtestlabs/ + excludedFiles: + - '' + then: + - addLabel: + label: Devtestlab + - if: + - includesModifiedFiles: + files: + - specification/dns/ + excludedFiles: + - '' + then: + - addLabel: + label: Network - DNS + - if: + - includesModifiedFiles: + files: + - specification/eventgrid/ + excludedFiles: + - '' + then: + - addLabel: + label: Event Grid + - if: + - includesModifiedFiles: + files: + - specification/eventhub/ + excludedFiles: + - '' + then: + - addLabel: + label: Event Hubs + - if: + - includesModifiedFiles: + files: + - specification/hdinsight/ + excludedFiles: + - '' + then: + - addLabel: + label: HDInsight + - if: + - includesModifiedFiles: + files: + - specification/intune/ + excludedFiles: + - '' + then: + - addLabel: + label: Intune + - if: + - includesModifiedFiles: + files: + - specification/iothub/ + excludedFiles: + - '' + then: + - addLabel: + label: IotHub + - if: + - includesModifiedFiles: + files: + - specification/keyvault/ + excludedFiles: + - '' + then: + - addLabel: + label: KeyVault + - if: + - includesModifiedFiles: + files: + - specification/logic/ + excludedFiles: + - '' + then: + - addLabel: + label: Logic App + - if: + - includesModifiedFiles: + files: + - specification/machinelearning/ + excludedFiles: + - '' + then: + - addLabel: + label: Machine Learning + - if: + - includesModifiedFiles: + files: + - specification/machinelearningcompute/ + excludedFiles: + - '' + then: + - addLabel: + label: Machine Learning Compute + - if: + - includesModifiedFiles: + files: + - specification/mediaservices/ + excludedFiles: + - '' + then: + - addLabel: + label: Media Services + - if: + - includesModifiedFiles: + files: + - specification/mobileengagement/ + excludedFiles: + - '' + then: + - addLabel: + label: Mobile Engagement + - if: + - includesModifiedFiles: + files: + - specification/monitor/ + excludedFiles: + - '' + then: + - addLabel: + label: Monitor + - if: + - includesModifiedFiles: + files: + - specification/mysql/ + excludedFiles: + - '' + then: + - addLabel: + label: MySQL + - if: + - includesModifiedFiles: + files: + - specification/network/ + excludedFiles: + - '' + then: + - addLabel: + label: Network + - if: + - includesModifiedFiles: + files: + - specification/notificationhubs/ + excludedFiles: + - '' + then: + - addLabel: + label: Notification Hub + - if: + - includesModifiedFiles: + files: + - specification/operationalinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: Monitor - Operational Insights + - if: + - includesModifiedFiles: + files: + - specification/operationsmanagement/ + excludedFiles: + - '' + then: + - addLabel: + label: Operations Management + - if: + - includesModifiedFiles: + files: + - specification/peering/ + excludedFiles: + - '' + then: + - addLabel: + label: Peering + - if: + - includesModifiedFiles: + files: + - specification/policyinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: Policy Insights + - if: + - includesModifiedFiles: + files: + - specification/postgresql/ + excludedFiles: + - '' + then: + - addLabel: + label: PostgreSQL + - if: + - includesModifiedFiles: + files: + - specification/provisioningservices/ + excludedFiles: + - '' + then: + - addLabel: + label: PostgreSQL + - if: + - includesModifiedFiles: + files: + - specification/recoveryservices/ + excludedFiles: + - '' + then: + - addLabel: + label: RecoveryServices + - if: + - includesModifiedFiles: + files: + - specification/recoveryservicesbackup/ + excludedFiles: + - '' + then: + - addLabel: + label: Recovery Services Backup + - if: + - includesModifiedFiles: + files: + - specification/recoveryservicessiterecovery/ + excludedFiles: + - '' + then: + - addLabel: + label: Recovery Services Site-Recovery + - if: + - includesModifiedFiles: + files: + - specification/redis/ + excludedFiles: + - '' + then: + - addLabel: + label: Redis Cache + - if: + - includesModifiedFiles: + files: + - specification/relay/ + excludedFiles: + - '' + then: + - addLabel: + label: Relay + - if: + - includesModifiedFiles: + files: + - specification/scheduler/ + excludedFiles: + - '' + then: + - addLabel: + label: Scheduler + - if: + - includesModifiedFiles: + files: + - specification/search/data-plane/ + excludedFiles: + - '' + then: + - addLabel: + label: Search + - if: + - includesModifiedFiles: + files: + - specification/search/resource-manager/ + excludedFiles: + - '' + then: + - addLabel: + label: Search + - if: + - includesModifiedFiles: + files: + - specification/service-map/ + excludedFiles: + - '' + then: + - addLabel: + label: Service Map + - if: + - includesModifiedFiles: + files: + - specification/servicebus/ + excludedFiles: + - '' + then: + - addLabel: + label: Service Bus + - if: + - includesModifiedFiles: + files: + - specification/servicefabric/ + excludedFiles: + - '' + then: + - addLabel: + label: Service Fabric + - if: + - includesModifiedFiles: + files: + - specification/sql/ + excludedFiles: + - '' + then: + - addLabel: + label: SQL + - if: + - includesModifiedFiles: + files: + - specification/storage/ + excludedFiles: + - '' + then: + - addLabel: + label: Storage + - if: + - includesModifiedFiles: + files: + - specification/storageimportexport/ + excludedFiles: + - '' + then: + - addLabel: + label: Import Export + - if: + - includesModifiedFiles: + files: + - specification/storagesync/ + excludedFiles: + - '' + then: + - addLabel: + label: StorageSync + - if: + - includesModifiedFiles: + files: + - specification/storsimple8000series/ + excludedFiles: + - '' + then: + - addLabel: + label: Storsimple + - if: + - includesModifiedFiles: + files: + - specification/streamanalytics/ + excludedFiles: + - '' + then: + - addLabel: + label: Stream Analytics + - if: + - includesModifiedFiles: + files: + - specification/subscriptions/ + excludedFiles: + - '' + then: + - addLabel: + label: Subscription + - if: + - includesModifiedFiles: + files: + - specification/synapse/ + excludedFiles: + - '' + then: + - addLabel: + label: Synapses + - if: + - includesModifiedFiles: + files: + - specification/loadtestservice/ + excludedFiles: + - '' + then: + - addLabel: + label: Load Test Service + - if: + - includesModifiedFiles: + files: + - specification/maps/ + excludedFiles: + - '' + then: + - addLabel: + label: Maps + - if: + - includesModifiedFiles: + files: + - specification/purview/ + excludedFiles: + - '' + then: + - addLabel: + label: Purview + - if: + - includesModifiedFiles: + files: + - specification/timeseriesinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: TimeseriesInsights + - if: + - includesModifiedFiles: + files: + - specification/trafficmanager/ + excludedFiles: + - '' + then: + - addLabel: + label: Network - Traffic Manager + - if: + - includesModifiedFiles: + files: + - specification/web/ + excludedFiles: + - '' + then: + - addLabel: + label: Web Apps + - if: + - includesModifiedFiles: + files: + - profile/ + excludedFiles: + - '' + then: + - addLabel: + label: Profile + - if: + - includesModifiedFiles: + files: + - specification/hybridcompute/resource-manager/ + - specification/connectedvmware/resource-manager/ + - specification/azurestackhci/resource-manager/ + - specification/scvmm/resource-manager/ + then: + - addLabel: + label: ArcReview + description: + - if: + - payloadType: Pull_Request + then: + - if: + - includesModifiedFiles: + files: + - dev/cognitiveservices/data-plane/Language/ + excludedFiles: + - '' + then: + - addLabel: + label: Cognitive Services + - if: + - includesModifiedFiles: + files: + - specification/analysisservices/ + excludedFiles: + - '' + then: + - addLabel: + label: Analysis Services + - if: + - includesModifiedFiles: + files: + - specification/alertsmanagement/ + excludedFiles: + - '' + then: + - addLabel: + label: Alerts Management + - if: + - includesModifiedFiles: + files: + - specification/apimanagement/ + excludedFiles: + - '' + then: + - addLabel: + label: API Management + - if: + - includesModifiedFiles: + files: + - specification/applicationinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: Insights + - if: + - includesModifiedFiles: + files: + - specification/applicationinsights/data-plane/Monitor.Exporters/ + excludedFiles: + - '' + then: + - addLabel: + label: Monitor - Exporter + - if: + - includesModifiedFiles: + files: + - specification/authorization/ + excludedFiles: + - '' + then: + - addLabel: + label: Authorization + - if: + - includesModifiedFiles: + files: + - specification/automation/ + excludedFiles: + - '' + then: + - addLabel: + label: Automation + - if: + - includesModifiedFiles: + files: + - specification/batch/ + excludedFiles: + - '' + then: + - addLabel: + label: Batch + - if: + - includesModifiedFiles: + files: + - specification/batchai/ + excludedFiles: + - '' + then: + - addLabel: + label: BatchAI + - if: + - includesModifiedFiles: + files: + - specification/billing/ + excludedFiles: + - '' + then: + - addLabel: + label: Billing + - if: + - includesModifiedFiles: + files: + - specification/cdn/ + excludedFiles: + - '' + then: + - addLabel: + label: Network - CDN + - if: + - includesModifiedFiles: + files: + - specification/cognitiveservices/ + excludedFiles: + - '' + then: + - addLabel: + label: Cognitive Services + - if: + - includesModifiedFiles: + files: + - specification/cognitiveservices/data-plane/Language/ + excludedFiles: + - '' + then: + - addLabel: + label: Cognitive - Language + - if: + - includesModifiedFiles: + files: + - specification/compute/ + excludedFiles: + - '' + then: + - addLabel: + label: Compute + - if: + - includesModifiedFiles: + files: + - specification/containerinstance/ + excludedFiles: + - '' + then: + - addLabel: + label: Container Instances + - if: + - includesModifiedFiles: + files: + - specification/containerregistry/ + excludedFiles: + - '' + then: + - addLabel: + label: Container Registry + - if: + - includesModifiedFiles: + files: + - specification/containerservice/ + excludedFiles: + - '' + then: + - addLabel: + label: Container Service + - if: + - includesModifiedFiles: + files: + - specification/cosmos-db/ + excludedFiles: + - '' + then: + - addLabel: + label: Cosmos + - if: + - includesModifiedFiles: + files: + - specification/customer-insights/ + excludedFiles: + - '' + then: + - addLabel: + label: Customer Insights + - if: + - includesModifiedFiles: + files: + - specification/datafactory/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Factory + - if: + - includesModifiedFiles: + files: + - specification/datalake-analytics/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Lake Analytics + - if: + - includesModifiedFiles: + files: + - specification/datalake-store/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Lake Store + - if: + - includesModifiedFiles: + files: + - specification/datamigration/ + excludedFiles: + - '' + then: + - addLabel: + label: Data Migration + - if: + - includesModifiedFiles: + files: + - specification/deviceupdate/data-plane/ + excludedFiles: + - '' + then: + - addLabel: + label: Device Update + - if: + - includesModifiedFiles: + files: + - specification/devtestlabs/ + excludedFiles: + - '' + then: + - addLabel: + label: Devtestlab + - if: + - includesModifiedFiles: + files: + - specification/dns/ + excludedFiles: + - '' + then: + - addLabel: + label: Network - DNS + - if: + - includesModifiedFiles: + files: + - specification/eventgrid/ + excludedFiles: + - '' + then: + - addLabel: + label: Event Grid + - if: + - includesModifiedFiles: + files: + - specification/eventhub/ + excludedFiles: + - '' + then: + - addLabel: + label: Event Hubs + - if: + - includesModifiedFiles: + files: + - specification/hdinsight/ + excludedFiles: + - '' + then: + - addLabel: + label: HDInsight + - if: + - includesModifiedFiles: + files: + - specification/intune/ + excludedFiles: + - '' + then: + - addLabel: + label: Intune + - if: + - includesModifiedFiles: + files: + - specification/iothub/ + excludedFiles: + - '' + then: + - addLabel: + label: IotHub + - if: + - includesModifiedFiles: + files: + - specification/keyvault/ + excludedFiles: + - '' + then: + - addLabel: + label: KeyVault + - if: + - includesModifiedFiles: + files: + - specification/logic/ + excludedFiles: + - '' + then: + - addLabel: + label: Logic App + - if: + - includesModifiedFiles: + files: + - specification/machinelearning/ + excludedFiles: + - '' + then: + - addLabel: + label: Machine Learning + - if: + - includesModifiedFiles: + files: + - specification/machinelearningcompute/ + excludedFiles: + - '' + then: + - addLabel: + label: Machine Learning Compute + - if: + - includesModifiedFiles: + files: + - specification/mediaservices/ + excludedFiles: + - '' + then: + - addLabel: + label: Media Services + - if: + - includesModifiedFiles: + files: + - specification/mobileengagement/ + excludedFiles: + - '' + then: + - addLabel: + label: Mobile Engagement + - if: + - includesModifiedFiles: + files: + - specification/monitor/ + excludedFiles: + - '' + then: + - addLabel: + label: Monitor + - if: + - includesModifiedFiles: + files: + - specification/mysql/ + excludedFiles: + - '' + then: + - addLabel: + label: MySQL + - if: + - includesModifiedFiles: + files: + - specification/network/ + excludedFiles: + - '' + then: + - addLabel: + label: Network + - if: + - includesModifiedFiles: + files: + - specification/notificationhubs/ + excludedFiles: + - '' + then: + - addLabel: + label: Notification Hub + - if: + - includesModifiedFiles: + files: + - specification/operationalinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: Monitor - Operational Insights + - if: + - includesModifiedFiles: + files: + - specification/operationsmanagement/ + excludedFiles: + - '' + then: + - addLabel: + label: Operations Management + - if: + - includesModifiedFiles: + files: + - specification/peering/ + excludedFiles: + - '' + then: + - addLabel: + label: Peering + - if: + - includesModifiedFiles: + files: + - specification/policyinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: Policy Insights + - if: + - includesModifiedFiles: + files: + - specification/postgresql/ + excludedFiles: + - '' + then: + - addLabel: + label: PostgreSQL + - if: + - includesModifiedFiles: + files: + - specification/provisioningservices/ + excludedFiles: + - '' + then: + - addLabel: + label: PostgreSQL + - if: + - includesModifiedFiles: + files: + - specification/recoveryservices/ + excludedFiles: + - '' + then: + - addLabel: + label: RecoveryServices + - if: + - includesModifiedFiles: + files: + - specification/recoveryservicesbackup/ + excludedFiles: + - '' + then: + - addLabel: + label: Recovery Services Backup + - if: + - includesModifiedFiles: + files: + - specification/recoveryservicessiterecovery/ + excludedFiles: + - '' + then: + - addLabel: + label: Recovery Services Site-Recovery + - if: + - includesModifiedFiles: + files: + - specification/redis/ + excludedFiles: + - '' + then: + - addLabel: + label: Redis Cache + - if: + - includesModifiedFiles: + files: + - specification/relay/ + excludedFiles: + - '' + then: + - addLabel: + label: Relay + - if: + - includesModifiedFiles: + files: + - specification/scheduler/ + excludedFiles: + - '' + then: + - addLabel: + label: Scheduler + - if: + - includesModifiedFiles: + files: + - specification/search/data-plane/ + excludedFiles: + - '' + then: + - addLabel: + label: Search + - if: + - includesModifiedFiles: + files: + - specification/search/resource-manager/ + excludedFiles: + - '' + then: + - addLabel: + label: Search + - if: + - includesModifiedFiles: + files: + - specification/service-map/ + excludedFiles: + - '' + then: + - addLabel: + label: Service Map + - if: + - includesModifiedFiles: + files: + - specification/servicebus/ + excludedFiles: + - '' + then: + - addLabel: + label: Service Bus + - if: + - includesModifiedFiles: + files: + - specification/servicefabric/ + excludedFiles: + - '' + then: + - addLabel: + label: Service Fabric + - if: + - includesModifiedFiles: + files: + - specification/sql/ + excludedFiles: + - '' + then: + - addLabel: + label: SQL + - if: + - includesModifiedFiles: + files: + - specification/storage/ + excludedFiles: + - '' + then: + - addLabel: + label: Storage + - if: + - includesModifiedFiles: + files: + - specification/storageimportexport/ + excludedFiles: + - '' + then: + - addLabel: + label: Import Export + - if: + - includesModifiedFiles: + files: + - specification/storagesync/ + excludedFiles: + - '' + then: + - addLabel: + label: StorageSync + - if: + - includesModifiedFiles: + files: + - specification/storsimple8000series/ + excludedFiles: + - '' + then: + - addLabel: + label: Storsimple + - if: + - includesModifiedFiles: + files: + - specification/streamanalytics/ + excludedFiles: + - '' + then: + - addLabel: + label: Stream Analytics + - if: + - includesModifiedFiles: + files: + - specification/subscriptions/ + excludedFiles: + - '' + then: + - addLabel: + label: Subscription + - if: + - includesModifiedFiles: + files: + - specification/synapse/ + excludedFiles: + - '' + then: + - addLabel: + label: Synapses + - if: + - includesModifiedFiles: + files: + - specification/timeseriesinsights/ + excludedFiles: + - '' + then: + - addLabel: + label: TimeseriesInsights + - if: + - includesModifiedFiles: + files: + - specification/trafficmanager/ + excludedFiles: + - '' + then: + - addLabel: + label: Network - Traffic Manager + - if: + - includesModifiedFiles: + files: + - specification/web/ + excludedFiles: + - '' + then: + - addLabel: + label: Web Apps + - if: + - includesModifiedFiles: + files: + - profile/ + excludedFiles: + - '' + then: + - addLabel: + label: Profile + description: + - if: + - payloadType: Issues + - hasLabel: + label: customer-reported + - hasLabel: + label: needs-triage + - isAction: + action: Labeled + then: + - addLabel: + label: CXP Attention + description: +onFailure: +onSuccess: diff --git a/eng/pipelines/typespec-validation-all.yml b/eng/pipelines/typespec-validation-all.yml index f830a130a1f1..8a5f34fb5e40 100644 --- a/eng/pipelines/typespec-validation-all.yml +++ b/eng/pipelines/typespec-validation-all.yml @@ -8,9 +8,19 @@ pr: none jobs: - job: Validate_All_Specs + + strategy: + matrix: + Linux: + Pool: azsdk-pool-mms-ubuntu-2204-general + OsVmImage: ubuntu-22.04 + Windows: + Pool: azsdk-pool-mms-win-2022-general + OsVmImage: windows-2022 + pool: - name: azsdk-pool-mms-ubuntu-2204-general - vmImage: ubuntu-22.04 + name: $(Pool) + vmImage: $(OSVmImage) steps: - script: npm ci diff --git a/eng/scripts/Get-TypeSpec-Folders.ps1 b/eng/scripts/Get-TypeSpec-Folders.ps1 index d815b1d455ba..387ee3aebb6a 100644 --- a/eng/scripts/Get-TypeSpec-Folders.ps1 +++ b/eng/scripts/Get-TypeSpec-Folders.ps1 @@ -40,7 +40,7 @@ else { ) $repoRootFiles = $changedFiles | Where-Object {$_ -in $rootFilesImpactingTypeSpec} - if ($engFiles -or $repoRootFiles) { + if (($Env:BUILD_REPOSITORY_NAME -eq 'azure/azure-rest-api-specs') -and ($engFiles -or $repoRootFiles)) { $changedFiles = $allChangedFiles } else { diff --git a/package-lock.json b/package-lock.json index 75d7842574bd..d40d7f94ff6d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,18 +7,18 @@ "name": "azure-rest-api-specs", "devDependencies": { "@azure-tools/typespec-apiview": "0.4.4", - "@azure-tools/typespec-autorest": "0.32.0", - "@azure-tools/typespec-azure-core": "0.32.0", - "@azure-tools/typespec-azure-resource-manager": "0.32.0", - "@azure-tools/typespec-client-generator-core": "0.32.0", - "@azure-tools/typespec-providerhub": "0.32.0", + "@azure-tools/typespec-autorest": "0.33.0", + "@azure-tools/typespec-azure-core": "0.33.0", + "@azure-tools/typespec-azure-resource-manager": "0.33.0", + "@azure-tools/typespec-client-generator-core": "0.33.0", + "@azure-tools/typespec-providerhub": "0.33.0", "@azure/avocado": "^0.8.4", "@types/prettier": "^2.7.2", - "@typespec/compiler": "0.46.0", - "@typespec/http": "0.46.0", - "@typespec/openapi": "0.46.0", - "@typespec/rest": "0.46.0", - "@typespec/versioning": "0.46.0", + "@typespec/compiler": "0.47.0", + "@typespec/http": "0.47.0", + "@typespec/openapi": "0.47.0", + "@typespec/rest": "0.47.0", + "@typespec/versioning": "0.47.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "prettier": "^2.8.8", "typescript": "~5.0.4" @@ -69,95 +69,95 @@ } }, "node_modules/@azure-tools/typespec-autorest": { - "version": "0.32.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.32.0.tgz", - "integrity": "sha512-EjF1tZdoMwUgcMRA6u3ZqabnmpvXsfnkEVvC8v7iL8v80EeGpn6ZjHzeH7jp8p/is4i54DAA9b8OFmxMEOed7A==", + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.33.0.tgz", + "integrity": "sha512-xA29JJt6Dnb8402xYJrR1dAwzEuhen/gcYeUk4KZrfn/3FsLpfiGQCwTAfcCd6iyLDRx7yQ34ysJmLt5ebcOdw==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.32.0", - "@typespec/compiler": "~0.46.0", - "@typespec/http": "~0.46.0", - "@typespec/openapi": "~0.46.0", - "@typespec/rest": "~0.46.0", - "@typespec/versioning": "~0.46.0" + "@azure-tools/typespec-azure-core": "~0.33.0", + "@typespec/compiler": "~0.47.0", + "@typespec/http": "~0.47.0", + "@typespec/openapi": "~0.47.0", + "@typespec/rest": "~0.47.0", + "@typespec/versioning": "~0.47.0" } }, "node_modules/@azure-tools/typespec-azure-core": { - "version": "0.32.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.32.0.tgz", - "integrity": "sha512-KnatCnncPVXQqUMHv5TYHrrcELtCCAbBIp3oMemqU8BLECs8KefOlLvxTqnkd9nSWdbcQTuJPnafmaH8A7gtrg==", + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.33.0.tgz", + "integrity": "sha512-DHa2WU21cuJ961OBXBjDYgFODsNwR77tAWxq7aRagLn/b1Y1xI+I455o99GU/N1T4k/jXGi382qvSkTF6xmsMQ==", "dev": true, "dependencies": { - "@typespec/lint": "~0.46.0" + "@typespec/lint": "~0.47.0" }, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0", - "@typespec/http": "~0.46.0", - "@typespec/rest": "~0.46.0" + "@typespec/compiler": "~0.47.0", + "@typespec/http": "~0.47.0", + "@typespec/rest": "~0.47.0" } }, "node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.32.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.32.0.tgz", - "integrity": "sha512-yeDhg5qC73bqlWxyNDqD0bhvsdNPKyczx3FY6hYT4xGP1fynZbk3OXEduJuDIi65f4H1e762TBZDvGPv1/y7uw==", + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.33.0.tgz", + "integrity": "sha512-8jkOae2Yf5fsYVh7ZgdC+a06Ghlfnk6DvLIQPouwOIftsmnUXScJdDIPodqxjdHuR5AWr053+OiKtVrJDWYgjw==", "dev": true, "dependencies": { - "@typespec/lint": "~0.46.0" + "@typespec/lint": "~0.47.0" }, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@azure-tools/typespec-autorest": "~0.32.0", - "@azure-tools/typespec-azure-core": "~0.32.0", - "@typespec/compiler": "~0.46.0", - "@typespec/http": "~0.46.0", - "@typespec/openapi": "~0.46.0", - "@typespec/rest": "~0.46.0", - "@typespec/versioning": "~0.46.0" + "@azure-tools/typespec-autorest": "~0.33.0", + "@azure-tools/typespec-azure-core": "~0.33.0", + "@typespec/compiler": "~0.47.0", + "@typespec/http": "~0.47.0", + "@typespec/openapi": "~0.47.0", + "@typespec/rest": "~0.47.0", + "@typespec/versioning": "~0.47.0" } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.32.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.32.0.tgz", - "integrity": "sha512-jukmmipTgyhnVe+Bzo8b8qQNZOTyZGxHZLsBryMEJJSJQwGPIz4eZ5O/GNSRmmBSau9+Fg/TE9rB/4lelE/c0w==", + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.33.0.tgz", + "integrity": "sha512-Cm6hxL7oEUfK5pyPHM0gbtlLVPQSE3qJbSVQDiTqGJaU/660GSLEjp9i+NfZ1nl+cDUBCaCKaFqongin+sbKuw==", "dev": true, "dependencies": { - "@typespec/lint": "~0.46.0" + "@typespec/lint": "~0.47.0" }, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0", - "@typespec/http": "~0.46.0", - "@typespec/rest": "~0.46.0", - "@typespec/versioning": "~0.46.0" + "@typespec/compiler": "~0.47.0", + "@typespec/http": "~0.47.0", + "@typespec/rest": "~0.47.0", + "@typespec/versioning": "~0.47.0" } }, "node_modules/@azure-tools/typespec-providerhub": { - "version": "0.32.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-providerhub/-/typespec-providerhub-0.32.0.tgz", - "integrity": "sha512-x6wrTxe8GdaY5RCiPLgLcKXNeIwbH7CNg+6M3DQ9DHWVEigr0tdSHUkyozLeqmaMbxUYUScinRzxoy/LR9Cklw==", + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-providerhub/-/typespec-providerhub-0.33.0.tgz", + "integrity": "sha512-18HRdQUwSrzcyDxP95REu4qIOL8SMjUhifZAJjGThwhkqczTxoeqPI3ek3ISFj9C7SsSvvlLAsL09kiy+GKYZA==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@azure-tools/typespec-autorest": "~0.32.0", - "@azure-tools/typespec-azure-core": "~0.32.0", - "@azure-tools/typespec-azure-resource-manager": "~0.32.0", - "@typespec/compiler": "~0.46.0", - "@typespec/http": "~0.46.0", - "@typespec/openapi": "~0.46.0", - "@typespec/rest": "~0.46.0", - "@typespec/versioning": "~0.46.0" + "@azure-tools/typespec-autorest": "~0.33.0", + "@azure-tools/typespec-azure-core": "~0.33.0", + "@azure-tools/typespec-azure-resource-manager": "~0.33.0", + "@typespec/compiler": "~0.47.0", + "@typespec/http": "~0.47.0", + "@typespec/openapi": "~0.47.0", + "@typespec/rest": "~0.47.0", + "@typespec/versioning": "~0.47.0" } }, "node_modules/@azure-tools/typespec-validation": { @@ -601,9 +601,9 @@ "dev": true }, "node_modules/@typespec/compiler": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.46.0.tgz", - "integrity": "sha512-CTt6WzGCUwXJ1w8Tto6/C3MtSa220Fo9pE2c4s+X620TxHV1kUb6ifOIkLonBbUHM++qSjXjG19kASoHXAQ08g==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.47.0.tgz", + "integrity": "sha512-4Y1WhTs4AScPkEsax14jW1QZMoqZl40OMgGiFB8MGDlTpcZV3zdWp1Wj13Q5rcAFYDc/Zl/wnDRgASRKQcqxoQ==", "dev": true, "dependencies": { "@babel/code-frame": "~7.22.5", @@ -612,9 +612,8 @@ "globby": "~13.1.1", "js-yaml": "~4.1.0", "mustache": "~4.2.0", - "node-watch": "~0.7.1", "picocolors": "~1.0.0", - "prettier": "~2.8.7", + "prettier": "~3.0.1", "prompts": "~2.4.1", "semver": "^7.3.8", "vscode-languageserver": "~8.1.0", @@ -722,6 +721,21 @@ "js-yaml": "bin/js-yaml.js" } }, + "node_modules/@typespec/compiler/node_modules/prettier": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.1.tgz", + "integrity": "sha512-fcOWSnnpCrovBsmFZIGIy9UqK2FaI7Hqax+DIO0A9UxeVoY4iweyaFjS5TavZN97Hfehph0nhsZnjlVKzEQSrQ==", + "dev": true, + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, "node_modules/@typespec/compiler/node_modules/vscode-jsonrpc": { "version": "8.1.0", "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.1.0.tgz", @@ -813,65 +827,65 @@ } }, "node_modules/@typespec/http": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.46.0.tgz", - "integrity": "sha512-MGZxRvgqsbTlHUFd7ueWwoIXMf0ZPjWtg7K4GjfS0XR4EAmag3zz4Y85QK6vSNFj7q7SxvLMKCezlCoo8KB1SA==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.47.0.tgz", + "integrity": "sha512-HrVu5mGV+p3KGPtcNFHB5gXm9pU4rYRG3hJWZdLcN8fy+OuwbhmOgjOGN4AB7HLllnISmcFn6LtlqGnr0LpyfA==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0" + "@typespec/compiler": "~0.47.0" } }, "node_modules/@typespec/lint": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@typespec/lint/-/lint-0.46.0.tgz", - "integrity": "sha512-aIW4rnBFhjMbfdLdPw0u5sx2Gn4uOWhqp4ttLv27hy8/itsDBEPzDd9ID+gy6AlsRqfJRwnK3xRiknLr+No6wA==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@typespec/lint/-/lint-0.47.0.tgz", + "integrity": "sha512-+CZ8OC8ABHU+HljjWvkVfLDZzyj2kc8VqEOHoXYdomt7PTo2GdVubyOXZMAYFiXWJr/k4YWHD2moPcvu+e2yTQ==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0" + "@typespec/compiler": "~0.47.0" } }, "node_modules/@typespec/openapi": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.46.0.tgz", - "integrity": "sha512-br54z+FpLU7T08Q89KBnhrGM7U+LfI0KnTbqpb0c8M0NZ+nbJvKGAVAHO/NcCA6J8L3TTEkUC1GaWhiwrUF8RQ==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.47.0.tgz", + "integrity": "sha512-p10NA5MQ1/z/yltTmK9g/RHgRQa+UPJg7ntcix8I9DIwX6u3yJReYwWBrKLeRNExd8ylNHNqjXTwiHJfptmR3w==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0", - "@typespec/http": "~0.46.0", - "@typespec/rest": "~0.46.0" + "@typespec/compiler": "~0.47.0", + "@typespec/http": "~0.47.0", + "@typespec/rest": "~0.47.0" } }, "node_modules/@typespec/rest": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.46.0.tgz", - "integrity": "sha512-WmSCI/J1QRy9W6Cq9595jqjyzCTYpOAWzzVDNMdyWH66BRVp3ckBdaXRynq1HfkUBaRd9qQCZGv1rA6qqhVTCA==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.47.0.tgz", + "integrity": "sha512-sjxCY2dQ6Wc51W7NYDLgcZdeTI35vFJR0aK+tuYHMTwjhZJK20ezwb/c+RZQ8xyGIyX+vUj9yhTc7lBZGw4n1A==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0" + "@typespec/compiler": "~0.47.0" } }, "node_modules/@typespec/versioning": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.46.0.tgz", - "integrity": "sha512-f0/pxvV+CZAfFZjQYS/tVm3qY9BigijCtja1vPeHBqe92TxQW10+He82LLOv6udAdRzuy+Zd+B8kzLVXa3ShUQ==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.47.0.tgz", + "integrity": "sha512-j3NUBm61k40ZI5aljgqfVFvduoR+q7ijLpwt+lzXw/DecOgNWZX7R/GGzwCmUVyfJUZpMA/8zhuxmx4fB36P7g==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.46.0" + "@typespec/compiler": "~0.47.0" } }, "node_modules/ansi-regex": { @@ -1730,15 +1744,6 @@ "node": ">=0.10.0" } }, - "node_modules/node-watch": { - "version": "0.7.3", - "resolved": "https://registry.npmjs.org/node-watch/-/node-watch-0.7.3.tgz", - "integrity": "sha512-3l4E8uMPY1HdMMryPRUAl+oIHtXtyiTlIiESNSVSNxcPfzAFzeTbXFQkZfAwBbo0B1qMSG8nUABx+Gd+YrbKrQ==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", diff --git a/package.json b/package.json index 5b6f4bfa8d87..df360fda9cf2 100644 --- a/package.json +++ b/package.json @@ -2,16 +2,16 @@ "name": "azure-rest-api-specs", "devDependencies": { "@azure-tools/typespec-apiview": "0.4.4", - "@azure-tools/typespec-autorest": "0.32.0", - "@azure-tools/typespec-azure-core": "0.32.0", - "@azure-tools/typespec-azure-resource-manager": "0.32.0", - "@azure-tools/typespec-client-generator-core": "0.32.0", - "@azure-tools/typespec-providerhub": "0.32.0", - "@typespec/compiler": "0.46.0", - "@typespec/http": "0.46.0", - "@typespec/openapi": "0.46.0", - "@typespec/rest": "0.46.0", - "@typespec/versioning": "0.46.0", + "@azure-tools/typespec-autorest": "0.33.0", + "@azure-tools/typespec-azure-core": "0.33.0", + "@azure-tools/typespec-azure-resource-manager": "0.33.0", + "@azure-tools/typespec-client-generator-core": "0.33.0", + "@azure-tools/typespec-providerhub": "0.33.0", + "@typespec/compiler": "0.47.0", + "@typespec/http": "0.47.0", + "@typespec/openapi": "0.47.0", + "@typespec/rest": "0.47.0", + "@typespec/versioning": "0.47.0", "@azure/avocado": "^0.8.4", "@types/prettier": "^2.7.2", "azure-rest-api-specs-eng-tools": "file:eng/tools", diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/agfood.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/agfood.json new file mode 100644 index 000000000000..bdb1e4b87393 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/agfood.json @@ -0,0 +1,21964 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Azure Data Manager for Agriculture Data Plane Service", + "description": "APIs documentation for Microsoft Azure Data Manager for Agriculture DataPlane Service.", + "version": "2023-07-01-preview" + }, + "paths": { + "/application-data:search": { + "post": { + "tags": [ + "ApplicationData" + ], + "description": "Search for ApplicationData across all parties by intersecting geometry.", + "operationId": "ApplicationData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchApplicationDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Search": { + "$ref": "./examples/ApplicationData_Search.json" + } + } + } + }, + "/application-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "ApplicationData" + ], + "description": "Create cascade delete job for application data resource.", + "operationId": "ApplicationData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "applicationDataId", + "description": "Id of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ApplicationData_CreateCascadeDeleteJob": { + "$ref": "./examples/ApplicationData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get cascade delete job for application data resource.", + "operationId": "ApplicationData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ApplicationData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/application-data/{applicationDataId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a specified application data resource under a particular party.", + "operationId": "ApplicationData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Get": { + "$ref": "./examples/ApplicationData_Get.json" + } + } + }, + "patch": { + "tags": [ + "ApplicationData" + ], + "description": "Creates or updates an application data resource under a particular party.", + "operationId": "ApplicationData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "applicationData", + "description": "Application data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + }, + "x-ms-examples": { + "ApplicationData_CreateOrUpdate": { + "$ref": "./examples/ApplicationData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ApplicationData" + ], + "description": "Deletes a specified application data resource under a particular party.", + "operationId": "ApplicationData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Delete": { + "$ref": "./examples/ApplicationData_Delete.json" + } + } + } + }, + "/parties/{partyId}/attachments": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Returns a paginated list of attachment resources under a particular party.", + "operationId": "Attachments_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceIds", + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "resourceTypes", + "description": "Resource Types of the resource.\r\ni.e. Party, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AttachmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Attachments_ListByPartyId": { + "$ref": "./examples/Attachments_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/attachments/{attachmentId}": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Gets a specified attachment resource under a particular party.", + "operationId": "Attachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Get": { + "$ref": "./examples/Attachments_Get.json" + } + } + }, + "patch": { + "tags": [ + "Attachments" + ], + "description": "Creates or updates an attachment resource under a particular party.", + "operationId": "Attachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "type": "file", + "format": "binary", + "description": "File to be uploaded." + }, + { + "in": "formData", + "name": "resourceId", + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "resourceType", + "description": "Associated Resource type for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "originalFileName", + "description": "Original File Name for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "id", + "description": "Unique id.", + "type": "string" + }, + { + "in": "formData", + "name": "status", + "description": "Status of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdDateTime", + "description": "Date when resource was created.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "modifiedDateTime", + "description": "Date when resource was last modified.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "source", + "description": "Source of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 2 + }, + { + "in": "formData", + "name": "name", + "description": "Name to identify resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "description", + "description": "Textual description of resource.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdBy", + "description": "Created by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "modifiedBy", + "description": "Modified by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "eTag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_CreateOrUpdate": { + "$ref": "./examples/Attachments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Attachments" + ], + "description": "Deletes a specified attachment resource under a particular party.", + "operationId": "Attachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Delete": { + "$ref": "./examples/Attachments_Delete.json" + } + } + } + }, + "/parties/{partyId}/attachments/{attachmentId}/file": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Downloads and returns attachment as response for the given input filePath.", + "operationId": "Attachments_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of attachment to be downloaded.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Download": { + "$ref": "./examples/Attachments_Download.json" + } + } + } + }, + "/crop-products": { + "get": { + "tags": [ + "CropProducts" + ], + "description": "Returns a paginated list of crop product resources.", + "operationId": "CropProducts_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Products of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "traits", + "description": "Traits of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProductListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropProducts_List": { + "$ref": "./examples/CropProducts_List.json" + } + } + } + }, + "/crop-products/{cropProductId}": { + "get": { + "tags": [ + "CropProducts" + ], + "description": "Gets a specified crop Product resource.", + "operationId": "CropProducts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_Get": { + "$ref": "./examples/CropProducts_Get.json" + } + } + }, + "patch": { + "tags": [ + "CropProducts" + ], + "description": "Creates or updates a crop Product resource.", + "operationId": "CropProducts_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "cropProduct", + "description": "Crop Product resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CropProduct" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_CreateOrUpdate": { + "$ref": "./examples/CropProducts_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "CropProducts" + ], + "description": "Deletes a specified crop Product resource.", + "operationId": "CropProducts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_Delete": { + "$ref": "./examples/CropProducts_Delete.json" + } + } + } + }, + "/crops": { + "get": { + "tags": [ + "Crops" + ], + "description": "Returns a paginated list of crop resources.", + "operationId": "Crops_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "phenotypes", + "description": "Crop phenotypes of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "breedingMethods", + "description": "Breeding method of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Crops_List": { + "$ref": "./examples/Crops_List.json" + } + } + } + }, + "/crops/{cropId}": { + "get": { + "tags": [ + "Crops" + ], + "description": "Gets a specified crop resource.", + "operationId": "Crops_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_Get": { + "$ref": "./examples/Crops_Get.json" + } + } + }, + "patch": { + "tags": [ + "Crops" + ], + "description": "Creates or updates a crop resource.", + "operationId": "Crops_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "crop", + "description": "Crop resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Crop" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_CreateOrUpdate": { + "$ref": "./examples/Crops_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Crops" + ], + "description": "Deletes Crop for given crop id.", + "operationId": "Crops_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of crop to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_Delete": { + "$ref": "./examples/Crops_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/device-data-models": { + "get": { + "tags": [ + "DeviceDataModels" + ], + "description": "Returns a paginated list of device data model resources.", + "operationId": "DeviceDataModels_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DeviceDataModels_List": { + "$ref": "./examples/DeviceDataModels_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}": { + "patch": { + "tags": [ + "DeviceDataModels" + ], + "description": "Create a device data model entity.", + "operationId": "DeviceDataModels_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "deviceDataModelObject", + "description": "Device data model object details.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_CreateOrUpdate": { + "$ref": "./examples/DeviceDataModels_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "DeviceDataModels" + ], + "description": "Gets a device data model entity.", + "operationId": "DeviceDataModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_Get": { + "$ref": "./examples/DeviceDataModels_Get.json" + } + } + }, + "delete": { + "tags": [ + "DeviceDataModels" + ], + "description": "Deletes a device data model entity.", + "operationId": "DeviceDataModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_Delete": { + "$ref": "./examples/DeviceDataModels_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/devices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Returns a paginated list of device resources.", + "operationId": "Devices_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentDeviceIds", + "description": "Id's of the parent devices.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "deviceDataModelIds", + "description": "Id's of the device data models.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Devices_List": { + "$ref": "./examples/Devices_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/devices/{deviceId}": { + "patch": { + "tags": [ + "Devices" + ], + "description": "Create a device entity.", + "operationId": "Devices_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "deviceDetails", + "description": "Device object details.", + "required": true, + "schema": { + "$ref": "#/definitions/Device" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_CreateOrUpdate": { + "$ref": "./examples/Devices_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Devices" + ], + "description": "Gets a device entity.", + "operationId": "Devices_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_Get": { + "$ref": "./examples/Devices_Get.json" + } + } + }, + "delete": { + "tags": [ + "Devices" + ], + "description": "Deletes a device entity.", + "operationId": "Devices_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_Delete": { + "$ref": "./examples/Devices_Delete.json" + } + } + } + }, + "/farm-operations/ingest-data/{jobId}": { + "put": { + "tags": [ + "FarmOperations" + ], + "description": "Create a farm operation data ingestion job.", + "operationId": "FarmOperations_CreateDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "FarmOperations_CreateDataIngestionJob": { + "$ref": "./examples/FarmOperations_CreateDataIngestionJob.json" + } + } + }, + "get": { + "tags": [ + "FarmOperations" + ], + "description": "Get a farm operation data ingestion job.", + "operationId": "FarmOperations_GetDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "FarmOperations_GetDataIngestionJobDetails": { + "$ref": "./examples/FarmOperations_GetDataIngestionJobDetails.json" + } + } + } + }, + "/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources across all parties.", + "operationId": "Farms_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_List": { + "$ref": "./examples/Farms_List.json" + } + } + } + }, + "/farms/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Farms" + ], + "description": "Create a cascade delete job for specified farm.", + "operationId": "Farms_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmId", + "description": "ID of the farm to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Farms_CreateCascadeDeleteJob": { + "$ref": "./examples/Farms_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Farms" + ], + "description": "Get a cascade delete job for specified farm.", + "operationId": "Farms_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farms_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources under a particular party.", + "operationId": "Farms_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_ListByPartyId": { + "$ref": "./examples/Farms_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/farms/{farmId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Gets a specified farm resource under a particular party.", + "operationId": "Farms_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "ID of the farm resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_Get": { + "$ref": "./examples/Farms_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farms" + ], + "description": "Creates or updates a farm resource under a particular party.", + "operationId": "Farms_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Id of the farm resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "farm", + "description": "Farm resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Farm" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_CreateOrUpdate": { + "$ref": "./examples/Farms_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farms" + ], + "description": "Deletes a specified farm resource under a particular party.", + "operationId": "Farms_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Id of the farm.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_Delete": { + "$ref": "./examples/Farms_Delete.json" + } + } + } + }, + "/fields:search": { + "post": { + "tags": [ + "Fields" + ], + "description": "Search for Fields across all parties by intersecting geometry.", + "operationId": "Fields_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFieldQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchFieldQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FieldMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Search": { + "$ref": "./examples/Fields_Search.json" + } + } + } + }, + "/fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a cascade delete job for specified field.", + "operationId": "Fields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Fields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Fields" + ], + "description": "Create a cascade delete job for specified field.", + "operationId": "Fields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "fieldId", + "description": "ID of the field to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Fields_CreateCascadeDeleteJob": { + "$ref": "./examples/Fields_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/fields/{fieldId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Gets a specified field resource under a particular party.", + "operationId": "Fields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Get": { + "$ref": "./examples/Fields_Get.json" + } + } + }, + "patch": { + "tags": [ + "Fields" + ], + "description": "Creates or Updates a field resource under a particular party.", + "operationId": "Fields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "field", + "description": "Field resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Field" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_CreateOrUpdate": { + "$ref": "./examples/Fields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Fields" + ], + "description": "Deletes a specified field resource under a particular party.", + "operationId": "Fields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Delete": { + "$ref": "./examples/Fields_Delete.json" + } + } + } + }, + "/harvest-data:search": { + "post": { + "tags": [ + "HarvestData" + ], + "description": "Search for HarvestData across all parties by intersecting geometry.", + "operationId": "HarvestData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchHarvestDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Search": { + "$ref": "./examples/HarvestData_Search.json" + } + } + } + }, + "/harvest-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "HarvestData" + ], + "description": "Create cascade delete job for harvest data resource.", + "operationId": "HarvestData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "harvestDataId", + "description": "Id of the harvest data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "HarvestData_CreateCascadeDeleteJob": { + "$ref": "./examples/HarvestData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get cascade delete job for harvest data resource.", + "operationId": "HarvestData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/HarvestData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/harvest-data/{harvestDataId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a specified harvest data resource under a particular party.", + "operationId": "HarvestData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Get": { + "$ref": "./examples/HarvestData_Get.json" + } + } + }, + "patch": { + "tags": [ + "HarvestData" + ], + "description": "Creates or updates harvest data resource under a particular party.", + "operationId": "HarvestData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "harvestData", + "description": "Harvest data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + }, + "x-ms-examples": { + "HarvestData_CreateOrUpdate": { + "$ref": "./examples/HarvestData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "HarvestData" + ], + "description": "Deletes a specified harvest data resource under a particular party.", + "operationId": "HarvestData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Delete": { + "$ref": "./examples/HarvestData_Delete.json" + } + } + } + }, + "/image-processing/rasterize/{jobId}": { + "put": { + "tags": [ + "ImageProcessing" + ], + "description": "Create a ImageProcessing Rasterize job.", + "operationId": "ImageProcessing_CreateRasterizeJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ImageProcessing_CreateRasterizeJob": { + "$ref": "./examples/ImageProcessing_CreateRasterizeJob.json" + } + } + }, + "get": { + "tags": [ + "ImageProcessing" + ], + "description": "Get ImageProcessing Rasterize job's details.", + "operationId": "ImageProcessing_GetRasterizeJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ImageProcessing_GetRasterizeJob": { + "$ref": "./examples/ImageProcessing_GetRasterizeJob.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments": { + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Returns a paginated list of insight resources.", + "operationId": "InsightAttachments_ListByPartyIdModelIdAndResource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "insightIds", + "description": "List of insight IDs.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "InsightAttachments_ListByPartyIdModelIdAndResource": { + "$ref": "./examples/InsightAttachments_ListByPartyIdModelIdAndResource.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}": { + "patch": { + "tags": [ + "InsightAttachments" + ], + "description": "Creates or updates insight entity.", + "operationId": "InsightAttachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "type": "file", + "format": "binary", + "description": "File to be uploaded." + }, + { + "in": "formData", + "name": "insightId", + "description": "InsightID for this InsightAttachment.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "originalFileName", + "description": "Original File Name for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "id", + "description": "Unique id.", + "type": "string" + }, + { + "in": "formData", + "name": "status", + "description": "Status of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdDateTime", + "description": "Date when resource was created.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "modifiedDateTime", + "description": "Date when resource was last modified.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "source", + "description": "Source of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 2 + }, + { + "in": "formData", + "name": "name", + "description": "Name to identify resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "description", + "description": "Textual description of resource.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdBy", + "description": "Created by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "modifiedBy", + "description": "Modified by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "eTag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_CreateOrUpdate": { + "$ref": "./examples/InsightAttachments_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Gets a specified insight resource under a particular party.", + "operationId": "InsightAttachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Get": { + "$ref": "./examples/InsightAttachments_Get.json" + } + } + }, + "delete": { + "tags": [ + "InsightAttachments" + ], + "description": "Deletes a specified insight resource.", + "operationId": "InsightAttachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Delete": { + "$ref": "./examples/InsightAttachments_Delete.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}/file": { + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Downloads and returns insight-attachment as response for the given input filePath.", + "operationId": "InsightAttachments_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Download": { + "$ref": "./examples/InsightAttachments_Download.json" + } + } + } + }, + "/insights/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Insights" + ], + "description": "Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.", + "operationId": "Insights_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceType", + "description": "Resource Type.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "insightId", + "description": "Insight id.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Insights_CreateCascadeDeleteJob": { + "$ref": "./examples/Insights_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Insights" + ], + "description": "Get a cascade delete job for specified insight.", + "operationId": "Insights_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Insights_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights": { + "get": { + "tags": [ + "Insights" + ], + "description": "Returns a paginated list of insight resources.", + "operationId": "Insights_ListByPartyIdModelIdAndResource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minInsightStartDateTime", + "description": "Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxInsightStartDateTime", + "description": "Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minInsightEndDateTime", + "description": "Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxInsightEndDateTime", + "description": "Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "measurementFilters", + "description": "Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object.\r\neg. \"measureKey.unit eq {testValue}\" where testValue is string.\r\neg. \"measureKey.value eq {testValue}\" where testValue = double.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Insights_ListByPartyIdModelIdAndResource": { + "$ref": "./examples/Insights_ListByPartyIdModelIdAndResource.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}": { + "patch": { + "tags": [ + "Insights" + ], + "description": "Creates or updates insight entity.", + "operationId": "Insights_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "insightData", + "description": "Insight data.", + "required": true, + "schema": { + "$ref": "#/definitions/Insight" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_CreateOrUpdate": { + "$ref": "./examples/Insights_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Insights" + ], + "description": "Gets a specified insight resource under a particular party.", + "operationId": "Insights_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_Get": { + "$ref": "./examples/Insights_Get.json" + } + } + }, + "delete": { + "tags": [ + "Insights" + ], + "description": "Deletes a specified insight resource.", + "operationId": "Insights_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_Delete": { + "$ref": "./examples/Insights_Delete.json" + } + } + } + }, + "/management-zones": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Returns a paginated list of management zone resources across all parties.", + "operationId": "ManagementZones_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "SeasonIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "FieldIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagementZones_List": { + "$ref": "./examples/ManagementZones_List.json" + } + } + } + }, + "/management-zones/cascade-delete/{jobId}": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Get a cascade delete job for specified job id.", + "operationId": "ManagementZones_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ManagementZones_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "ManagementZones" + ], + "description": "Create a cascade delete job for specified management zone.", + "operationId": "ManagementZones_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "managementZoneId", + "description": "ID of the management zone to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ManagementZones_CreateCascadeDeleteJob": { + "$ref": "./examples/ManagementZones_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/management-zones": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Returns a paginated list of management zone resources under a particular party.", + "operationId": "ManagementZones_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "SeasonIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "FieldIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagementZones_ListByPartyId": { + "$ref": "./examples/ManagementZones_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/management-zones/{managementZoneId}": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Gets a specified management zone resource under a particular party.", + "operationId": "ManagementZones_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_Get": { + "$ref": "./examples/ManagementZones_Get.json" + } + } + }, + "patch": { + "tags": [ + "ManagementZones" + ], + "description": "Creates or updates a management zone resource.", + "operationId": "ManagementZones_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "managementZone", + "description": "ManagementZone resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementZone" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_CreateOrUpdate": { + "$ref": "./examples/ManagementZones_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ManagementZones" + ], + "description": "Deletes a specified management zone resource under a particular party.", + "operationId": "ManagementZones_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_Delete": { + "$ref": "./examples/ManagementZones_Delete.json" + } + } + } + }, + "/model-inference/models/microsoft-biomass/infer-data/{jobId}": { + "put": { + "tags": [ + "ModelInference" + ], + "description": "Create a Biomass Model job.", + "operationId": "ModelInference_CreateBiomassModelJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/BiomassModelJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/BiomassModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ModelInference_CreateBiomassModelJob": { + "$ref": "./examples/ModelInference_CreateBiomassModelJob.json" + } + } + }, + "get": { + "tags": [ + "ModelInference" + ], + "description": "Get Biomass Model job's details.", + "operationId": "ModelInference_GetBiomassModelJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BiomassModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ModelInference_GetBiomassModelJob": { + "$ref": "./examples/ModelInference_GetBiomassModelJob.json" + } + } + } + }, + "/model-inference/models/microsoft-sensor-placement/infer-data/{jobId}": { + "put": { + "tags": [ + "ModelInference" + ], + "description": "Create a Sensor Placement Model job.", + "operationId": "ModelInference_CreateSensorPlacementModelJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorPlacementModelJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SensorPlacementModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ModelInference_CreateSensorPlacementModelJob": { + "$ref": "./examples/ModelInference_CreateSensorPlacementModelJob.json" + } + } + }, + "get": { + "tags": [ + "ModelInference" + ], + "description": "Get Sensor Placement Model job's details.", + "operationId": "ModelInference_GetSensorPlacementModelJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPlacementModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ModelInference_GetSensorPlacementModelJob": { + "$ref": "./examples/ModelInference_GetSensorPlacementModelJob.json" + } + } + } + }, + "/model-inference/models/microsoft-soil-moisture/infer-data/{jobId}": { + "put": { + "tags": [ + "ModelInference" + ], + "description": "Create a SoilMoisture Model job.", + "operationId": "ModelInference_CreateSoilMoistureModelJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SoilMoistureModelJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SoilMoistureModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ModelInference_CreateSoilMoistureModelJob": { + "$ref": "./examples/ModelInference_CreateSoilMoistureModelJob.json" + } + } + }, + "get": { + "tags": [ + "ModelInference" + ], + "description": "Get SoilMoisture Model job's details.", + "operationId": "ModelInference_GetSoilMoistureModelJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SoilMoistureModelJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ModelInference_GetSoilMoistureModelJob": { + "$ref": "./examples/ModelInference_GetSoilMoistureModelJob.json" + } + } + } + }, + "/nutrient-analyses": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Returns a paginated list of nutrient analysis resources across all parties.", + "operationId": "NutrientAnalyses_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "classifications", + "description": "Classifications for nutrient analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NutrientAnalyses_List": { + "$ref": "./examples/NutrientAnalyses_List.json" + } + } + } + }, + "/parties/{partyId}/nutrient-analyses": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Returns a paginated list of nutrient analysis resources under a particular party.", + "operationId": "NutrientAnalyses_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "classifications", + "description": "Classifications for nutrient analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NutrientAnalyses_ListByPartyId": { + "$ref": "./examples/NutrientAnalyses_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Gets a specified nutrient analysis resource under a particular party.", + "operationId": "NutrientAnalyses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_Get": { + "$ref": "./examples/NutrientAnalyses_Get.json" + } + } + }, + "patch": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Creates or updates a nutrient analysis resource.", + "operationId": "NutrientAnalyses_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "nutrientAnalysis", + "description": "NutrientAnalysis resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_CreateOrUpdate": { + "$ref": "./examples/NutrientAnalyses_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Deletes a specified nutrient analysis resource under a particular party.", + "operationId": "NutrientAnalyses_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_Delete": { + "$ref": "./examples/NutrientAnalyses_Delete.json" + } + } + } + }, + "/oauth/providers": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Returns a paginated list of oauthProvider resources.", + "operationId": "OAuthProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthProviders_List": { + "$ref": "./examples/OAuthProviders_List.json" + } + } + } + }, + "/oauth/providers/{oauthProviderId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get a specified oauthProvider resource.", + "operationId": "OAuthProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of the oauthProvider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_Get": { + "$ref": "./examples/OAuthProviders_Get.json" + } + } + }, + "patch": { + "tags": [ + "OAuthProviders" + ], + "description": "Creates or updates an oauthProvider resource.", + "operationId": "OAuthProviders_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of oauthProvider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "oauthProvider", + "description": "OauthProvider resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_CreateOrUpdate": { + "$ref": "./examples/OAuthProviders_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OAuthProviders" + ], + "description": "Deletes an specified oauthProvider resource.", + "operationId": "OAuthProviders_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of oauthProvider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_Delete": { + "$ref": "./examples/OAuthProviders_Delete.json" + } + } + } + }, + "/oauth/providers/cascade-delete/{jobId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get cascade delete job for oauthProvider resource.", + "operationId": "OAuthProviders_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthProviders_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthProviders" + ], + "description": "Create cascade delete job for oauthProvider resource.", + "operationId": "OAuthProviders_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthProviders_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthProviders_CreateCascadeDeleteJob.json" + } + } + } + }, + "/oauth/tokens": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns a list of OAuthToken documents.", + "operationId": "OAuthTokens_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "authProviderIds", + "description": "Name of AuthProvider.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "partyIds", + "description": "List of parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "isValid", + "description": "If the token object is valid.", + "type": "boolean" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthTokenListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthTokens_List": { + "$ref": "./examples/OAuthTokens_List.json" + } + } + } + }, + "/oauth/tokens/:connect": { + "post": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns Connection link needed in the OAuth flow.", + "operationId": "OAuthTokens_GetOAuthConnectionLink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "oauthConnectRequest", + "description": "OAuth Connect Request.", + "required": true, + "schema": { + "$ref": "#/definitions/OAuthConnectRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthTokens_GetOAuthConnectionLink": { + "$ref": "./examples/OAuthTokens_GetOAuthConnectionLink.json" + } + } + } + }, + "/oauth/tokens/remove/{jobId}": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Get remove job for OAuth token.", + "operationId": "OAuthTokens_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthTokens_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthTokens_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthTokens" + ], + "description": "Create remove job for OAuth token.", + "operationId": "OAuthTokens_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the OAuthProvider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthTokens_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthTokens_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties": { + "get": { + "tags": [ + "Parties" + ], + "description": "Returns a paginated list of party resources.", + "operationId": "Parties_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Parties_List": { + "$ref": "./examples/Parties_List.json" + } + } + } + }, + "/parties:overlap": { + "post": { + "tags": [ + "Parties" + ], + "description": "Returns overlapping area between two resources.", + "operationId": "Parties_GeoOverlap", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "overlapResources", + "description": "Overlap Resources.", + "required": true, + "schema": { + "$ref": "#/definitions/OverlapResourcesQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartyOverlapResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_GeoOverlap": { + "$ref": "./examples/Parties_GeoOverlap.json" + } + } + } + }, + "/parties/{partyId}": { + "get": { + "tags": [ + "Parties" + ], + "description": "Gets a specified party resource.", + "operationId": "Parties_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_Get": { + "$ref": "./examples/Parties_Get.json" + } + } + }, + "patch": { + "tags": [ + "Parties" + ], + "description": "Creates or updates a party resource.", + "operationId": "Parties_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "party", + "description": "Party resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Party" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_CreateOrUpdate": { + "$ref": "./examples/Parties_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Parties" + ], + "description": "Deletes a specified party resource.", + "operationId": "Parties_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of party to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_Delete": { + "$ref": "./examples/Parties_Delete.json" + } + } + } + }, + "/parties/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Parties" + ], + "description": "Get a cascade delete job for specified party.", + "operationId": "Parties_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Parties_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Parties" + ], + "description": "Create a cascade delete job for specified party.", + "operationId": "Parties_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the party to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Parties_CreateCascadeDeleteJob": { + "$ref": "./examples/Parties_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/planting-data/{plantingDataId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a specified planting data resource under a particular party.", + "operationId": "PlantingData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Get": { + "$ref": "./examples/PlantingData_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantingData" + ], + "description": "Creates or updates an planting data resource under a particular party.", + "operationId": "PlantingData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "plantingData", + "description": "Planting data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + }, + "x-ms-examples": { + "PlantingData_CreateOrUpdate": { + "$ref": "./examples/PlantingData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantingData" + ], + "description": "Deletes a specified planting data resource under a particular party.", + "operationId": "PlantingData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Delete": { + "$ref": "./examples/PlantingData_Delete.json" + } + } + } + }, + "/planting-data:search": { + "post": { + "tags": [ + "PlantingData" + ], + "description": "Search for PlantingData across all parties by intersecting geometry.", + "operationId": "PlantingData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchPlantingDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Search": { + "$ref": "./examples/PlantingData_Search.json" + } + } + } + }, + "/planting-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "PlantingData" + ], + "description": "Create cascade delete job for planting data resource.", + "operationId": "PlantingData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "plantingDataId", + "description": "Id of the planting data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantingData_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantingData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get cascade delete job for planting data resource.", + "operationId": "PlantingData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantingData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}": { + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Gets a specified plant tissue analysis resource under a particular party.", + "operationId": "PlantTissueAnalyses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Get": { + "$ref": "./examples/PlantTissueAnalyses_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Creates or updates a plant tissue analysis resource.", + "operationId": "PlantTissueAnalyses_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "plantTissueAnalysis", + "description": "PlantTissueAnalysis resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_CreateOrUpdate": { + "$ref": "./examples/PlantTissueAnalyses_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Deletes a specified plant tissue analysis resource under a particular party.", + "operationId": "PlantTissueAnalyses_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Delete": { + "$ref": "./examples/PlantTissueAnalyses_Delete.json" + } + } + } + }, + "/plant-tissue-analyses:search": { + "post": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Search for PlantTissueAnalyses across all parties by intersecting geometry.", + "operationId": "PlantTissueAnalyses_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchPlantTissueAnalysisQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchPlantTissueAnalysisQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysisMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Search": { + "$ref": "./examples/PlantTissueAnalyses_Search.json" + } + } + } + }, + "/plant-tissue-analyses/cascade-delete/{jobId}": { + "put": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Create a cascade delete job for specified plant tissue analysis.", + "operationId": "PlantTissueAnalyses_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "plantTissueAnalysisId", + "description": "ID of the plant tissue analysis to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantTissueAnalyses_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Get a cascade delete job for specified plant tissue analysis.", + "operationId": "PlantTissueAnalyses_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/prescription-maps": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Returns a paginated list of prescription map resources under a particular party.", + "operationId": "PrescriptionMaps_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMapListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrescriptionMaps_ListByPartyId": { + "$ref": "./examples/PrescriptionMaps_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/prescription-maps/{prescriptionMapId}": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Gets a specified prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescription map.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_Get": { + "$ref": "./examples/PrescriptionMaps_Get.json" + } + } + }, + "patch": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Creates or Updates a prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescription map resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "prescriptionMap", + "description": "PrescriptionMap resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_CreateOrUpdate": { + "$ref": "./examples/PrescriptionMaps_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Deletes a specified prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescriptionMap.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_Delete": { + "$ref": "./examples/PrescriptionMaps_Delete.json" + } + } + } + }, + "/prescription-maps": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Returns a paginated list of prescription map resources across all parties.", + "operationId": "PrescriptionMaps_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMapListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrescriptionMaps_List": { + "$ref": "./examples/PrescriptionMaps_List.json" + } + } + } + }, + "/prescription-maps/cascade-delete/{jobId}": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Get a cascade delete job for specified prescription map.", + "operationId": "PrescriptionMaps_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Create a cascade delete job for specified prescription map.", + "operationId": "PrescriptionMaps_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionMapId", + "description": "ID of the prescription map to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrescriptionMaps_CreateCascadeDeleteJob": { + "$ref": "./examples/PrescriptionMaps_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/prescriptions/{prescriptionId}": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Gets a specified prescription resource under a particular party.", + "operationId": "Prescriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Get": { + "$ref": "./examples/Prescriptions_Get.json" + } + } + }, + "patch": { + "tags": [ + "Prescriptions" + ], + "description": "Creates or Updates a prescription resource under a particular party.", + "operationId": "Prescriptions_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "prescription", + "description": "Prescription resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Prescription" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_CreateOrUpdate": { + "$ref": "./examples/Prescriptions_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Prescriptions" + ], + "description": "Deletes a specified prescription resource under a particular party.", + "operationId": "Prescriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Delete": { + "$ref": "./examples/Prescriptions_Delete.json" + } + } + } + }, + "/prescription:search": { + "post": { + "tags": [ + "Prescriptions" + ], + "description": "Search for Prescriptions across all parties by intersecting geometry.", + "operationId": "Prescriptions_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchPrescriptionQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchPrescriptionQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Search": { + "$ref": "./examples/Prescriptions_Search.json" + } + } + } + }, + "/prescriptions/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Get a cascade delete job for specified prescription.", + "operationId": "Prescriptions_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Prescriptions_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Prescriptions" + ], + "description": "Create a cascade delete job for specified prescription.", + "operationId": "Prescriptions_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionId", + "description": "ID of the prescription to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prescriptions_CreateCascadeDeleteJob": { + "$ref": "./examples/Prescriptions_CreateCascadeDeleteJob.json" + } + } + } + }, + "/scenes": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Returns a paginated list of scene resources.", + "operationId": "Scenes_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "provider", + "description": "Provider name of scene data. Supported value: SentinelHub.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "PartyId.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "associatedResourceId", + "description": "Associated Resource Id of the resource.", + "type": "string" + }, + { + "in": "query", + "name": "associatedResourceType", + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "source", + "description": "Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCloudCoveragePercentage", + "description": "Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "maxDarkPixelCoveragePercentage", + "description": "Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "imageNames", + "description": "List of image names to be filtered.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageResolutions", + "description": "List of image resolutions in meters to be filtered.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageFormats", + "description": "List of image formats to be filtered.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SceneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Scenes_List": { + "$ref": "./examples/Scenes_List.json" + } + } + } + }, + "/scenes/downloadFiles": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Downloads and returns file Stream as response for the given input filePath.", + "operationId": "Scenes_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "query", + "name": "filePath", + "description": "cloud storage path of scene file.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_Download": { + "$ref": "./examples/Scenes_Download.json" + } + } + } + }, + "/scenes/satellite/ingest-data/{jobId}": { + "put": { + "tags": [ + "Scenes" + ], + "description": "Create a satellite data ingestion job.", + "operationId": "Scenes_CreateSatelliteDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Scenes_CreateSatelliteDataIngestionJob": { + "$ref": "./examples/Scenes_CreateSatelliteDataIngestionJob.json" + } + } + }, + "get": { + "tags": [ + "Scenes" + ], + "description": "Get a satellite data ingestion job.", + "operationId": "Scenes_GetSatelliteDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_GetSatelliteDataIngestionJobDetails": { + "$ref": "./examples/Scenes_GetSatelliteDataIngestionJobDetails.json" + } + } + } + }, + "/scenes/stac-collections/{collectionId}:search": { + "post": { + "tags": [ + "Scenes" + ], + "description": "Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.", + "operationId": "Scenes_SearchFeatures", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "collectionId", + "description": "Collection Id to be searched.", + "required": true, + "type": "string", + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "x-ms-enum": { + "name": "collectionId", + "modelAsString": true + } + }, + { + "in": "query", + "name": "maxpagesize", + "description": "Maximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10.", + "type": "integer", + "format": "int32", + "default": 10, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "skip", + "description": "Skip token for getting next set of results.", + "type": "integer", + "format": "int32", + "maximum": 2147483647, + "minimum": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFeaturesQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchFeaturesQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SearchFeaturesResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_SearchFeatures": { + "$ref": "./examples/Scenes_SearchFeatures.json" + } + } + } + }, + "/parties/{partyId}/seasonal-fields/{seasonalFieldId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Gets a specified seasonal field resource under a particular party.", + "operationId": "SeasonalFields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Get": { + "$ref": "./examples/SeasonalFields_Get.json" + } + } + }, + "patch": { + "tags": [ + "SeasonalFields" + ], + "description": "Creates or Updates a seasonal field resource under a particular party.", + "operationId": "SeasonalFields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "seasonalField", + "description": "Seasonal field resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/SeasonalField" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_CreateOrUpdate": { + "$ref": "./examples/SeasonalFields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SeasonalFields" + ], + "description": "Deletes a specified seasonal-field resource under a particular party.", + "operationId": "SeasonalFields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Delete": { + "$ref": "./examples/SeasonalFields_Delete.json" + } + } + } + }, + "/seasonal-fields:search": { + "post": { + "tags": [ + "SeasonalFields" + ], + "description": "Search for SeasonalFields across all parties by intersecting geometry.", + "operationId": "SeasonalFields_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchSeasonalFieldQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchSeasonalFieldQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalFieldMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Search": { + "$ref": "./examples/SeasonalFields_Search.json" + } + } + } + }, + "/seasonal-fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/SeasonalFields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "SeasonalFields" + ], + "description": "Create a cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "seasonalFieldId", + "description": "ID of the seasonalField to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SeasonalFields_CreateCascadeDeleteJob": { + "$ref": "./examples/SeasonalFields_CreateCascadeDeleteJob.json" + } + } + } + }, + "/seasons": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Returns a paginated list of season resources.", + "operationId": "Seasons_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minStartDateTime", + "description": "Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxStartDateTime", + "description": "Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minEndDateTime", + "description": "Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxEndDateTime", + "description": "Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "years", + "description": "Years of the resource.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Seasons_List": { + "$ref": "./examples/Seasons_List.json" + } + } + } + }, + "/seasons/{seasonId}": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Gets a specified season resource.", + "operationId": "Seasons_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_Get": { + "$ref": "./examples/Seasons_Get.json" + } + } + }, + "patch": { + "tags": [ + "Seasons" + ], + "description": "Creates or updates a season resource.", + "operationId": "Seasons_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "season", + "description": "Season resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Season" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_CreateOrUpdate": { + "$ref": "./examples/Seasons_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Seasons" + ], + "description": "Deletes a specified season resource.", + "operationId": "Seasons_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_Delete": { + "$ref": "./examples/Seasons_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensor-data-models": { + "get": { + "tags": [ + "SensorDataModels" + ], + "description": "Returns a paginated list of sensor data model resources.", + "operationId": "SensorDataModels_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorDataModels_List": { + "$ref": "./examples/SensorDataModels_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}": { + "patch": { + "tags": [ + "SensorDataModels" + ], + "description": "Create a sensor data model entity.", + "operationId": "SensorDataModels_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorDataModelObject", + "description": "Sensor data model object details.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_CreateOrUpdate": { + "$ref": "./examples/SensorDataModels_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorDataModels" + ], + "description": "Gets a sensor data model entity.", + "operationId": "SensorDataModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_Get": { + "$ref": "./examples/SensorDataModels_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorDataModels" + ], + "description": "Deletes a sensor data model entity.", + "operationId": "SensorDataModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_Delete": { + "$ref": "./examples/SensorDataModels_Delete.json" + } + } + } + }, + "/sensor-events": { + "get": { + "tags": [ + "SensorEvents" + ], + "description": "Returns a list of sensor events data. Time span for query is limited to 90 days at a time.\r\nReturns last 90 days events when startDateTime and endDateTime are not provided.", + "operationId": "SensorEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorId", + "description": "Id of the associated sensor.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "excludeDuplicateEvents", + "description": "Flag to exclude duplicate events and take the latest ones only (Default: false).", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorEventListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorEvents_List": { + "$ref": "./examples/SensorEvents_List.json" + } + } + } + }, + "/sensor-mappings": { + "get": { + "tags": [ + "SensorMappings" + ], + "description": "Returns a paginated list of sensor mapping resources.", + "operationId": "SensorMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorIds", + "description": "Id of the sensors.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sensorPartnerIds", + "description": "Id of the sensor partners.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "partyIds", + "description": "Id of the parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedResourceIds", + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedResourceType", + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, FarmOperationApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMappingListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorMappings_List": { + "$ref": "./examples/SensorMappings_List.json" + } + } + } + }, + "/sensor-mappings/{sensorMappingId}": { + "patch": { + "tags": [ + "SensorMappings" + ], + "description": "Create a sensor mapping entity.", + "operationId": "SensorMappings_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorMappingObject", + "description": "Sensor mapping object details.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorMapping" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_CreateOrUpdate": { + "$ref": "./examples/SensorMappings_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorMappings" + ], + "description": "Gets a sensor mapping entity.", + "operationId": "SensorMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_Get": { + "$ref": "./examples/SensorMappings_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorMappings" + ], + "description": "Deletes a sensor mapping entity.", + "operationId": "SensorMappings_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_Delete": { + "$ref": "./examples/SensorMappings_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations": { + "get": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Gets partner integration models.", + "operationId": "SensorPartnerIntegrations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyIds", + "description": "Ids of the parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorPartnerIntegrations_List": { + "$ref": "./examples/SensorPartnerIntegrations_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}": { + "patch": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Create or update an integration with a sensor partner.", + "operationId": "SensorPartnerIntegrations_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration to be created.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorPartnerIntegrationModel", + "description": "Partner integration model.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_CreateOrUpdate": { + "$ref": "./examples/SensorPartnerIntegrations_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Gets a partner integration model entity.", + "operationId": "SensorPartnerIntegrations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_Get": { + "$ref": "./examples/SensorPartnerIntegrations_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Deletes a partner integration model entity.", + "operationId": "SensorPartnerIntegrations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_Delete": { + "$ref": "./examples/SensorPartnerIntegrations_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent": { + "post": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Checks consent for partner integration.", + "operationId": "SensorPartnerIntegrations_CheckConsent", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "description": "Partner integration key.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationCheckConsentResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_CheckConsent": { + "$ref": "./examples/SensorPartnerIntegrations_CheckConsent.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:generate-consent-link": { + "post": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Generates partner integration consent link.", + "operationId": "SensorPartnerIntegrations_GenerateConsentLink", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationGenerateConsentLinkResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_GenerateConsentLink": { + "$ref": "./examples/SensorPartnerIntegrations_GenerateConsentLink.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors": { + "get": { + "tags": [ + "Sensors" + ], + "description": "Returns a paginated list of sensor resources.", + "operationId": "Sensors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorDataModelIds", + "description": "Id's of the sensor data models.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sensorMappingIds", + "description": "Ids of the sensor mappings.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "deviceIds", + "description": "Id's of the devices.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Sensors_List": { + "$ref": "./examples/Sensors_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}": { + "patch": { + "tags": [ + "Sensors" + ], + "description": "Create a sensor entity.", + "operationId": "Sensors_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorDetails", + "description": "Sensor object details.", + "required": true, + "schema": { + "$ref": "#/definitions/Sensor" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_CreateOrUpdate": { + "$ref": "./examples/Sensors_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Sensors" + ], + "description": "Gets a sensor entity.", + "operationId": "Sensors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_Get": { + "$ref": "./examples/Sensors_Get.json" + } + } + }, + "delete": { + "tags": [ + "Sensors" + ], + "description": "Deletes a sensor entity.", + "operationId": "Sensors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_Delete": { + "$ref": "./examples/Sensors_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings": { + "get": { + "tags": [ + "Sensors" + ], + "description": "Gets a sensor connection string.", + "operationId": "Sensors_GetConnectionString", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IoTHubDeviceAuthentication" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_GetConnectionString": { + "$ref": "./examples/Sensors_GetConnectionString.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings/:renew": { + "post": { + "tags": [ + "Sensors" + ], + "description": "Renews a sensor connection string.", + "operationId": "Sensors_RenewConnectionString", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "renewConnectionStringModel", + "description": "Sensor's connection string model.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorRenewConnectionStringModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IoTHubDeviceAuthentication" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_RenewConnectionString": { + "$ref": "./examples/Sensors_RenewConnectionString.json" + } + } + } + }, + "/solutions/{solutionId}:cancel": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Cancels a job for given solution id.", + "operationId": "SolutionInference_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of solution for which job is to be cancelled.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SolutionInference_Cancel": { + "$ref": "./examples/SolutionInference_Cancel.json" + } + } + } + }, + "/solutions/{solutionId}:create": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Creates a job trigger for a solution.", + "operationId": "SolutionInference_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of the solution resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SolutionInference_CreateOrUpdate": { + "$ref": "./examples/SolutionInference_CreateOrUpdate.json" + } + } + } + }, + "/solutions/{solutionId}:fetch": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Fetches details of triggered job for a solution.", + "operationId": "SolutionInference_Fetch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of the solution.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SolutionInference_Fetch": { + "$ref": "./examples/SolutionInference_Fetch.json" + } + } + } + }, + "/parties/{partyId}/tillage-data/{tillageDataId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a specified tillage data resource under a particular party.", + "operationId": "TillageData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Get": { + "$ref": "./examples/TillageData_Get.json" + } + } + }, + "patch": { + "tags": [ + "TillageData" + ], + "description": "Creates or updates an tillage data resource under a particular party.", + "operationId": "TillageData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "tillageData", + "description": "Tillage data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/TillageData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + }, + "x-ms-examples": { + "TillageData_CreateOrUpdate": { + "$ref": "./examples/TillageData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "TillageData" + ], + "description": "Deletes a specified tillage data resource under a particular party.", + "operationId": "TillageData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Delete": { + "$ref": "./examples/TillageData_Delete.json" + } + } + } + }, + "/tillage-data:search": { + "post": { + "tags": [ + "TillageData" + ], + "description": "Search for TillageData across all parties by intersecting geometry.", + "operationId": "TillageData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchTillageDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Search": { + "$ref": "./examples/TillageData_Search.json" + } + } + } + }, + "/tillage-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "TillageData" + ], + "description": "Create cascade delete job for tillage data resource.", + "operationId": "TillageData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "tillageDataId", + "description": "Id of the tillage data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "TillageData_CreateCascadeDeleteJob": { + "$ref": "./examples/TillageData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "TillageData" + ], + "description": "Get cascade delete job for tillage data resource.", + "operationId": "TillageData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/TillageData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/weather-data:fetch": { + "post": { + "tags": [ + "WeatherData" + ], + "description": "Returns a list of WeatherData.", + "operationId": "WeatherData_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "weatherDataProviderRequest", + "description": "Weather data provider request.", + "required": true, + "schema": { + "$ref": "#/definitions/WeatherDataProviderRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataProviderResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "WeatherData_Get": { + "$ref": "./examples/WeatherData_Get.json" + } + } + } + }, + "/parties/{partyId}/zones/{zoneId}": { + "get": { + "tags": [ + "Zones" + ], + "description": "Gets a specified zone resource under a particular party.", + "operationId": "Zones_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Get": { + "$ref": "./examples/Zones_Get.json" + } + } + }, + "patch": { + "tags": [ + "Zones" + ], + "description": "Creates or updates a Zone resource.", + "operationId": "Zones_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "zone", + "description": "Zone resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Zone" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_CreateOrUpdate": { + "$ref": "./examples/Zones_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Zones" + ], + "description": "Deletes a specified zone resource under a particular party.", + "operationId": "Zones_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Delete": { + "$ref": "./examples/Zones_Delete.json" + } + } + } + }, + "/zone:search": { + "post": { + "tags": [ + "Zones" + ], + "description": "Search for Zones across all parties by intersecting geometry.", + "operationId": "Zones_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "format": "int32", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchZoneQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchZoneQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ZoneMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Search": { + "$ref": "./examples/Zones_Search.json" + } + } + } + }, + "/zones/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Zones" + ], + "description": "Get a cascade delete job for specified job id.", + "operationId": "Zones_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Zones_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Zones" + ], + "description": "Create a cascade delete job for specified zone.", + "operationId": "Zones_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "zoneId", + "description": "ID of the zone to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Zones_CreateCascadeDeleteJob": { + "$ref": "./examples/Zones_CreateCascadeDeleteJob.json" + } + } + } + } + }, + "definitions": { + "AdditionalProviderParameters": { + "description": "Schema of additional parameters for weather data provider request.", + "type": "object", + "properties": { + "iconResolution": { + "description": "Icon Resolution (Only applicable for AzureWeatherMaps).", + "type": "string" + }, + "details": { + "description": "Details (Only applicable for AzureWeatherMaps).", + "default": true, + "type": "boolean" + } + } + }, + "ApiKeyAuthCredentials": { + "description": "Api Key Auth Credentials class for API Key based Auth.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + }, + { + "required": [ + "apiKey" + ], + "type": "object", + "properties": { + "apiKey": { + "$ref": "#/definitions/KeyVaultProperties" + } + } + } + ], + "x-ms-discriminator-value": "ApiKeyAuthCredentials" + }, + "ApplicationData": { + "description": "Schema of application data resource.", + "type": "object", + "properties": { + "applicationProductDetails": { + "description": "Application product details.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationProductDetail" + } + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataMetaData": { + "description": "Schema of application data resource.", + "type": "object", + "properties": { + "applicationProductDetails": { + "description": "Application product details.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationProductDetail" + } + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "ApplicationProductDetail": { + "description": "Schema of product used during application.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product applied.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "isCarrier": { + "description": "A flag indicating whether product is a carrier for a tank mix.", + "default": false, + "type": "boolean" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "Attachment": { + "description": "Schema of attachment resource.", + "type": "object", + "properties": { + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + "resourceType": { + "description": "Associated Resource type for this attachment.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField", + "ApplicationData", + "HarvestData", + "TillageData", + "PlantingData", + "PlantTissueAnalysis" + ], + "type": "string", + "x-ms-enum": { + "name": "AttachmentResourceType", + "modelAsString": true + } + }, + "originalFileName": { + "description": "Original File Name for this attachment.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "PartyId id for this attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date when resource was created.", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date when resource was last modified.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "AttachmentListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Attachment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "AuthCredentials": { + "description": "AuthCredentials abstract base class for Auth Purpose.", + "required": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/AuthCredentialsKind" + } + }, + "discriminator": "kind" + }, + "AuthCredentialsKind": { + "description": "CredentialTypeEnum.", + "enum": [ + "OAuthClientCredentials", + "ApiKeyAuthCredentials" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthCredentialsKind", + "modelAsString": true + } + }, + "BiomassModelJob": { + "description": "Schema of biomass model job.", + "required": [ + "associatedResource", + "cropName", + "imageFormat", + "imageResolution", + "inferenceEndDateTime", + "modelVersion", + "partyId", + "plantingStartDateTime", + "satelliteProvider", + "satelliteSource", + "weatherExtensionId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "modelVersion": { + "description": "The version of the biomass model to be run. Available Value: 1.0 .", + "minLength": 1, + "type": "string" + }, + "cropName": { + "description": "Crop name for biomass model. Available Value: Corn.", + "minLength": 1, + "enum": [ + "Corn" + ], + "type": "string", + "x-ms-enum": { + "name": "CropName", + "modelAsString": true + } + }, + "plantingStartDateTime": { + "format": "date-time", + "description": "Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "inferenceEndDateTime": { + "format": "date-time", + "description": "End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "weatherExtensionId": { + "description": "ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string" + }, + "satelliteProvider": { + "description": "Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise).", + "minLength": 1, + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "satelliteSource": { + "description": "Source of satellite data. Available Value: Sentinel_2_L2A.", + "minLength": 1, + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "imageResolution": { + "format": "double", + "description": "ImageResolution in meters. Available values: 10, 20, 60.", + "type": "number" + }, + "imageFormat": { + "description": "ImageFormat. Available value: TIF.", + "minLength": 1, + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CascadeDeleteJob": { + "description": "Schema of cascade delete job.", + "required": [ + "partyId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "resourceId": { + "description": "The id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceType": { + "description": "The type of the resource.", + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "enum": [ + "Waiting", + "Running", + "Succeeded", + "Failed", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + } + } + }, + "Crop": { + "description": "Schema of crop resource.", + "type": "object", + "properties": { + "phenotype": { + "description": "Crop phenotype.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "breedingMethod": { + "description": "Breeding Method.", + "enum": [ + "VARIETY", + "HYBRID", + "UNKNOWN" + ], + "type": "string", + "x-ms-enum": { + "name": "BreedingMethod", + "modelAsString": true + } + }, + "measurements": { + "description": "Measurements.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Crop" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "CropProduct": { + "description": "Schema of crop product resource.", + "type": "object", + "properties": { + "cropIds": { + "description": "Ids of the crops it belongs to.\r\nNote: A maximum of 25 crops can be associated with a cropProduct.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "brand": { + "description": "CropProduct Brand.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "CropProduct product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "trait": { + "description": "CropProduct trait.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "relativeMaturity": { + "$ref": "#/definitions/Measure" + }, + "treatments": { + "description": "CropProduct treatments.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropProductListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CropProduct" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DataProvider": { + "description": "Provider of satellite data.", + "enum": [ + "Microsoft" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "Device": { + "description": "Device API model.", + "type": "object", + "properties": { + "deviceDataModelId": { + "description": "Id of the associated device data model.", + "type": "string" + }, + "integrationId": { + "description": "Integration id for the device.", + "type": "string" + }, + "type": { + "description": "Type of device.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "hardwareId": { + "description": "Device hardwareId.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "reportingIntervalInSeconds": { + "format": "int32", + "description": "Interval at which the device sends data in seconds.", + "type": "integer" + }, + "parentDeviceId": { + "description": "Parent device Id for this device.", + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DeviceDataModel": { + "description": "DeviceDataModel API model.", + "type": "object", + "properties": { + "type": { + "description": "Type of device.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "manufacturer": { + "description": "Device manufacturer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productCode": { + "description": "Device productCode.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "ports": { + "description": "List of device ports supported.", + "type": "array", + "items": { + "$ref": "#/definitions/Port" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DeviceDataModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DeviceListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Device" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Error": { + "description": "An error from the Azure AgPlatform service.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "minLength": 1, + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "Target of the error.", + "type": "string" + }, + "details": { + "description": "Array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorForLocation": { + "description": "Model for error information for a failed location.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/WeatherLocation" + }, + "code": { + "format": "int32", + "description": "Status code returned by data provider.", + "type": "integer" + }, + "description": { + "description": "Description of the error.", + "type": "string" + }, + "retryable": { + "description": "Flag suggesting if retry attempt with same request body should be made to fetch required data.", + "type": "boolean" + } + } + }, + "ErrorResponse": { + "description": "An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + }, + "traceId": { + "description": "Unique trace Id.", + "type": "string" + } + } + }, + "Farm": { + "description": "Schema of farm resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Farm" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "FarmOperationDataIngestionJob": { + "description": "Schema of farm operation data ingestion job.", + "required": [ + "authProviderId", + "partyId", + "providerInput", + "startYear" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "authProviderId": { + "description": "Authentication provider Id.", + "minLength": 1, + "type": "string" + }, + "operations": { + "description": "List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.", + "type": "array", + "items": { + "type": "string" + } + }, + "startYear": { + "format": "int32", + "description": "Start Year (Minimum = 2000, Maximum = CurrentYear).", + "type": "integer" + }, + "isIncremental": { + "description": "Use this to pull only the incremental changes from the last run.", + "default": false, + "type": "boolean" + }, + "providerInput": { + "$ref": "#/definitions/FarmOperationJobProviderInput" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmOperationJobProviderInput": { + "description": "Schema for provider input for Farm operations job.", + "required": [ + "shapeResolution", + "shapeType" + ], + "type": "object", + "properties": { + "shapeType": { + "description": "Type of shape file to be ingested from Operation Data Provider.", + "minLength": 1, + "enum": [ + "Point", + "Polygon" + ], + "type": "string", + "x-ms-enum": { + "name": "ShapeType", + "modelAsString": true + } + }, + "shapeResolution": { + "description": "Resolution of shape file to be ingested from Operation Data Provider.", + "minLength": 1, + "enum": [ + "EachSection", + "EachSensor", + "OneHertz" + ], + "type": "string", + "x-ms-enum": { + "name": "ShapeResolution", + "modelAsString": true + } + } + } + }, + "Field": { + "description": "Schema of field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldMetaData": { + "description": "Schema of field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "GeoJsonObject": { + "description": "GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonObjectType" + } + }, + "discriminator": "type" + }, + "GeoJsonObjectType": { + "description": "GeoJSON object type.", + "enum": [ + "Point", + "Polygon", + "MultiPolygon" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": true + } + }, + "GeoResource": { + "description": "Schema for storing resource type and resource id.", + "type": "object", + "properties": { + "type": { + "description": "Resource Type.", + "enum": [ + "Field", + "SeasonalField", + "Zone", + "Prescription", + "PlantTissueAnalysis", + "PlantingData", + "ApplicationData", + "HarvestData", + "TillageData" + ], + "type": "string", + "x-ms-enum": { + "name": "FarmHierarchyGeoResourceType", + "modelAsString": true + } + }, + "id": { + "description": "Resource Id.", + "type": "string" + } + } + }, + "HarvestData": { + "description": "Schema of harvest data resource.", + "type": "object", + "properties": { + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "avgSpeed": { + "$ref": "#/definitions/Measure" + }, + "harvestProductDetails": { + "description": "Harvest product details.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataMetaData": { + "description": "Schema of harvest data resource.", + "type": "object", + "properties": { + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "avgSpeed": { + "$ref": "#/definitions/Measure" + }, + "harvestProductDetails": { + "description": "Harvest product details.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "HarvestProductDetail": { + "description": "Schema of product used during harvesting.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + } + } + }, + "ImageFile": { + "description": "Schema of image file resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "fileLink": { + "description": "Link of the image file.", + "type": "string" + }, + "name": { + "description": "Name of the image file.", + "minLength": 1, + "type": "string" + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "resolution": { + "format": "double", + "description": "Resolution of image file in meters.", + "type": "number" + } + } + }, + "ImageFormat": { + "description": "Supported image formats for scene resource.", + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "ImageProcessingRasterizeJob": { + "description": "Image Processing Rasterize Job to convert shapefile into tiff file.", + "required": [ + "partyId", + "shapefileAttachmentId", + "shapefileColumnNames" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "shapefileAttachmentId": { + "description": "Shapefile attachment Id.", + "minLength": 1, + "type": "string" + }, + "shapefileColumnNames": { + "description": "List of shapefile column names to create raster attachments.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "InnerError": { + "description": "Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.", + "type": "object", + "properties": { + "code": { + "description": "Specific error code than was provided by the containing error.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "Insight": { + "description": "Schema of insight resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated party.", + "type": "string", + "readOnly": true + }, + "modelId": { + "description": "Id of the associated model.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Resource type associated with the record.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FarmHierarchyResourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Id of the associated resource.", + "type": "string", + "readOnly": true + }, + "modelVersion": { + "description": "Version of the associated model.", + "type": "string" + }, + "attachmentsLink": { + "description": "Gets link for attachments.", + "type": "string", + "readOnly": true + }, + "insightStartDateTime": { + "format": "date-time", + "description": "Start date to which the insight is related.", + "type": "string" + }, + "insightEndDateTime": { + "format": "date-time", + "description": "End date to which the insight is related.", + "type": "string" + }, + "measurements": { + "description": "Measures to capture insights results.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "InsightAttachment": { + "description": "Schema of insight attachment resource.", + "required": [ + "insightId" + ], + "type": "object", + "properties": { + "insightId": { + "description": "InsightID for this InsightAttachment.", + "minLength": 1, + "type": "string" + }, + "modelId": { + "description": "ModelID for this InsightAttachment.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Associated Resource type for this attachment.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FarmHierarchyResourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string", + "readOnly": true + }, + "originalFileName": { + "description": "Original File Name for this attachment.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "PartyId id for this attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date when resource was created.", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date when resource was last modified.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "InsightAttachmentListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "InsightListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Insight" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "IoTHubDeviceAuthentication": { + "description": "Authentication via connection string to IoTHub devices.", + "type": "object", + "properties": { + "primaryDeviceConnectionString": { + "description": "Primary connection string of the ioTHub device.", + "type": "string", + "readOnly": true + }, + "secondaryDeviceConnectionString": { + "description": "Secondary connection string of the ioTHub device.", + "type": "string", + "readOnly": true + } + } + }, + "KeyVaultProperties": { + "description": "Properties of the key vault.", + "required": [ + "keyName", + "keyVaultUri", + "keyVersion" + ], + "type": "object", + "properties": { + "keyVaultUri": { + "description": "Uri of the key vault.", + "minLength": 1, + "type": "string" + }, + "keyName": { + "description": "Name of Key Vault key.", + "minLength": 1, + "type": "string" + }, + "keyVersion": { + "description": "Version of Key Vault key.", + "minLength": 1, + "type": "string" + } + } + }, + "LabDetails": { + "description": "Model for representing LabDetails object.", + "type": "object", + "properties": { + "code": { + "description": "Code of the resource.", + "maxLength": 150, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "address": { + "description": "Address of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + } + } + }, + "Location": { + "description": "Location model class.", + "required": [ + "latitude", + "longitude" + ], + "type": "object", + "properties": { + "latitude": { + "format": "double", + "description": "Latitude of the location.", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "format": "double", + "description": "Longitude of the location.", + "maximum": 180, + "minimum": -180, + "type": "number" + } + } + }, + "ManagementZone": { + "description": "Api Model for ManagementZone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the ManagementZone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the ManagementZone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "seasonId": { + "description": "Season Id associated with the ManagementZone.", + "type": "string" + }, + "cropId": { + "description": "Crop Id associated with the ManagementZone.", + "type": "string" + }, + "fieldId": { + "description": "Field Id associated with the ManagementZone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ManagementZoneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementZone" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Measure": { + "description": "Schema for storing measurement reading and unit.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "value": { + "format": "double", + "description": "Data value.", + "type": "number" + } + } + }, + "Measures": { + "description": "Schema for storing measurement readings and unit.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "values": { + "description": "Data values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "MultiPolygon": { + "description": "MultiPolygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets Coordinates of GeoJSON Object.\r\nIt must be an array of polygons, each polygon contains list of linear rings.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings.", + "minItems": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + } + ], + "x-ms-discriminator-value": "MultiPolygon" + }, + "NutrientAnalysis": { + "description": "Api Model for nutrient analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party id for this nutrient analysis.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "Parent id for this nutrient analysis.", + "type": "string" + }, + "parentType": { + "description": "Parent type for this nutrient analysis.\r\ni.e. PlantTissueAnalysis.", + "enum": [ + "PlantTissueAnalysis" + ], + "type": "string", + "x-ms-enum": { + "name": "NutrientAnalysisParentType", + "modelAsString": true + } + }, + "unit": { + "description": "Unit for this nutrient analysis.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "value": { + "format": "double", + "description": "Value for this nutrient analysis.", + "type": "number" + }, + "referenceValueLow": { + "format": "double", + "description": "Reference value low for this nutrient analysis.", + "type": "number" + }, + "referenceValueHigh": { + "format": "double", + "description": "Reference value high for this nutrient analysis.", + "type": "number" + }, + "classification": { + "description": "Classification for this nutrient analysis.", + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "recommendation": { + "description": "Recommendation for this nutrient analysis.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "products": { + "description": "Products for this nutrient analysis.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductDetails" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "NutrientAnalysisListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OAuthClientCredentials": { + "description": "OAuthClientCredentials for clientId clientSecret auth.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + }, + { + "required": [ + "clientId", + "clientSecret" + ], + "type": "object", + "properties": { + "clientId": { + "description": "ClientId associated with the provider.", + "minLength": 1, + "type": "string" + }, + "clientSecret": { + "$ref": "#/definitions/KeyVaultProperties" + } + } + } + ], + "x-ms-discriminator-value": "OAuthClientCredentials" + }, + "OAuthConnectRequest": { + "description": "Get OAuth config query parameters.", + "required": [ + "oAuthProviderId", + "partyId", + "userRedirectLink" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Id of the party.", + "minLength": 1, + "type": "string" + }, + "oAuthProviderId": { + "description": "Id of the OAuthProvider.", + "minLength": 1, + "type": "string" + }, + "userRedirectLink": { + "description": "Link to redirect the user to, at the end of the oauth flow.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "userRedirectState": { + "description": "State to provide back when redirecting the user, at the end of the oauth flow.", + "maxLength": 200, + "minLength": 0, + "type": "string" + } + } + }, + "OAuthProvider": { + "description": "Schema of OAuth provider resource.", + "type": "object", + "properties": { + "appId": { + "description": "OAuth App Id for given OAuth Provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "appSecret": { + "description": "OAuth App secret for given Provider.\r\nNote: Won't be sent in response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "apiKey": { + "description": "OAuth Api key for given Provider.\r\nNote: currently Applicable to Climate provider. Won't be sent in response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "isProductionApp": { + "description": "An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)", + "default": false, + "type": "boolean" + }, + "id": { + "description": "Unique OAuth provider ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProviderCascadeDeleteJob": { + "description": "Schema of oauth provider cascade delete job.", + "required": [ + "oauthProviderId" + ], + "type": "object", + "properties": { + "oauthProviderId": { + "description": "The id of the oauth provider.", + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProviderListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OAuthToken": { + "description": "Schema of OAuth token resource.", + "required": [ + "authProviderId", + "partyId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party ID for this OAuth config.", + "type": "string" + }, + "authProviderId": { + "description": "ID of the OAuth provider resource containing app information.", + "minLength": 1, + "type": "string" + }, + "isValid": { + "description": "An optional flag indicating whether the token is a valid or expired (Default value: true).", + "default": true, + "type": "boolean" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + } + } + }, + "OAuthTokenListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/OAuthToken" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OverlapResource": { + "description": "Schema of overlap resource.", + "required": [ + "partyId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceType": { + "description": "Resource type of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceId": { + "description": "Id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceArea": { + "format": "double", + "description": "Acreage of the resource.", + "type": "number", + "readOnly": true + } + } + }, + "OverlapResourcesQuery": { + "description": "Overlap Resource Query Parameters.", + "type": "object", + "properties": { + "resources": { + "description": "List of resources.", + "maxItems": 2, + "minItems": 2, + "type": "array", + "items": { + "$ref": "#/definitions/OverlapResource" + } + } + } + }, + "Party": { + "description": "Schema of party resource.", + "type": "object", + "properties": { + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PartyListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Party" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PartyOverlapResponse": { + "description": "Schema of Party Overlap Response.", + "type": "object", + "properties": { + "resources": { + "description": "Resources with area.", + "maxItems": 2, + "minItems": 2, + "type": "array", + "items": { + "$ref": "#/definitions/OverlapResource" + } + }, + "overlappingArea": { + "format": "double", + "description": "Acreage of overlapping area.", + "type": "number" + } + } + }, + "PlantTissueAnalysis": { + "description": "Api Model for plant tissue analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated Party.", + "type": "string", + "readOnly": true + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "cropId": { + "description": "Id of the associated Crop.", + "type": "string" + }, + "cropProductId": { + "description": "Id of the associated Crop product.", + "type": "string" + }, + "seasonId": { + "description": "Id of the associated Season.", + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "Planting datetime for this plant tissue analysis.", + "type": "string" + }, + "growthStage": { + "description": "Growth stage for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPart": { + "description": "Plant part for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPosition": { + "description": "Plant position for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantAppearance": { + "description": "Plant appearance for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionCondition": { + "description": "Sample collection condition for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionDateTime": { + "format": "date-time", + "description": "Sample collection dateTime for this plant tissue analysis.", + "type": "string" + }, + "sampleReceivedDateTime": { + "format": "date-time", + "description": "Sample received dateTime.", + "type": "string" + }, + "sampleTestResultDateTime": { + "format": "date-time", + "description": "Sample test result dateTime for this plant tissue analysis.", + "type": "string" + }, + "labDetails": { + "$ref": "#/definitions/LabDetails" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantTissueAnalysisMetaData": { + "description": "Api Model for plant tissue analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated Party.", + "type": "string", + "readOnly": true + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "cropId": { + "description": "Id of the associated Crop.", + "type": "string" + }, + "cropProductId": { + "description": "Id of the associated Crop product.", + "type": "string" + }, + "seasonId": { + "description": "Id of the associated Season.", + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "Planting datetime for this plant tissue analysis.", + "type": "string" + }, + "growthStage": { + "description": "Growth stage for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPart": { + "description": "Plant part for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPosition": { + "description": "Plant position for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantAppearance": { + "description": "Plant appearance for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionCondition": { + "description": "Sample collection condition for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionDateTime": { + "format": "date-time", + "description": "Sample collection dateTime for this plant tissue analysis.", + "type": "string" + }, + "sampleReceivedDateTime": { + "format": "date-time", + "description": "Sample received dateTime.", + "type": "string" + }, + "sampleTestResultDateTime": { + "format": "date-time", + "description": "Sample test result dateTime for this plant tissue analysis.", + "type": "string" + }, + "labDetails": { + "$ref": "#/definitions/LabDetails" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantTissueAnalysisMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantTissueAnalysisMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "PlantingData": { + "description": "Schema of planting data resource.", + "type": "object", + "properties": { + "avgPlantingRate": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "plantingProductDetails": { + "description": "Planting product details.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataMetaData": { + "description": "Schema of planting data resource.", + "type": "object", + "properties": { + "avgPlantingRate": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "plantingProductDetails": { + "description": "Planting product details.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "PlantingProductDetail": { + "description": "Schema for Planting product detail.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product.", + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "Point": { + "description": "Point geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets the coordinate of this point.\r\nIt must be an array of 2 or 3 elements for a 2D or 3D system.", + "maximum": 3, + "minimum": 2, + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + ], + "x-ms-discriminator-value": "Point" + }, + "Polygon": { + "description": "Polygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets type of the GeoJSON Object.\r\nIt must be an array of linear ring coordinate arrays.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings.", + "minItems": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + ], + "x-ms-discriminator-value": "Polygon" + }, + "Port": { + "description": "Schema for storing port values.", + "type": "object", + "properties": { + "name": { + "description": "Name of the port.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Type of port digital/analog.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "Prescription": { + "description": "Api Model for Prescription object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "prescriptionMapId": { + "description": "Prescription map Id.", + "type": "string" + }, + "productCode": { + "description": "Product Code.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productName": { + "description": "Product name.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Prescription type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measurements": { + "description": "Measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMap": { + "description": "Api Model for Prescription Map object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Prescription map type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "seasonId": { + "description": "Season Id.", + "type": "string" + }, + "cropId": { + "description": "Crop Id.", + "type": "string" + }, + "fieldId": { + "description": "Field Id.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMapListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PrescriptionMetaData": { + "description": "Api Model for Prescription object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "prescriptionMapId": { + "description": "Prescription map Id.", + "type": "string" + }, + "productCode": { + "description": "Product Code.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productName": { + "description": "Product name.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Prescription type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measurements": { + "description": "Measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrescriptionMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "ProductDetails": { + "description": "Model for representing ProductDetails object.", + "type": "object", + "properties": { + "rate": { + "description": "Rate of the product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "instruction": { + "description": "Instruction of the resource.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "Product of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "SatelliteData": { + "description": "Data Model for SatelliteIngestionJobRequest.", + "type": "object", + "properties": { + "imageNames": { + "description": "List of ImageNames.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NDVI" + ] + }, + "imageFormats": { + "description": "List of ImageFormats. Available value: TIF.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "TIF" + ] + }, + "imageResolutions": { + "description": "List of ImageResolutions in meters. Available values: 10, 20, 60.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "example": [ + 10 + ] + } + } + }, + "SatelliteDataIngestionJob": { + "description": "Schema of satellite data ingestion job.", + "required": [ + "associatedResource", + "endDateTime", + "partyId", + "provider", + "source", + "startDateTime" + ], + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/OAuthClientCredentials" + }, + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "startDateTime": { + "format": "date-time", + "description": "Start Date.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End Date.", + "type": "string" + }, + "provider": { + "$ref": "#/definitions/DataProvider" + }, + "source": { + "$ref": "#/definitions/Source" + }, + "data": { + "$ref": "#/definitions/SatelliteData" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object" + } + } + }, + "Scene": { + "description": "Schema of scene resource.", + "type": "object", + "properties": { + "sceneDateTime": { + "format": "date-time", + "description": "Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "provider": { + "description": "Data provider of the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "source": { + "description": "Data source of the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "imageFiles": { + "description": "Collection of image files.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageFile" + } + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "cloudCoverPercentage": { + "format": "double", + "description": "Cloud cover percentage of the scene.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "darkPixelPercentage": { + "format": "double", + "description": "Dark pixel percentage of the scene.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "ndviMedianValue": { + "format": "double", + "description": "Median of NDVI of the scene.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "partyId": { + "description": "Party ID which belongs to the scene.", + "type": "string" + }, + "id": { + "description": "Unique scene resource ID.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + } + } + }, + "SceneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Scene" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SearchApplicationDataQuery": { + "description": "SearchApplicationDataQuery.", + "type": "object", + "properties": { + "minAvgMaterial": { + "format": "double", + "description": "Minimum average amount of material applied during the application (inclusive).", + "type": "number" + }, + "maxAvgMaterial": { + "format": "double", + "description": "Maximum average amount of material applied during the application (inclusive).", + "type": "number" + }, + "minTotalMaterial": { + "format": "double", + "description": "Minimum total amount of material applied during the application (inclusive).", + "type": "number" + }, + "maxTotalMaterial": { + "format": "double", + "description": "Maximum total amount of material applied during the application (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchFeaturesQuery": { + "description": "Search stac Features parameters.", + "required": [ + "endDateTime", + "startDateTime" + ], + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/OAuthClientCredentials" + }, + "startDateTime": { + "format": "date-time", + "description": "Start datetime of the time interval in which to search for Features.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End datetime of the time interval in which to search for Features.", + "type": "string" + }, + "intersects": { + "$ref": "#/definitions/GeoJsonObject" + }, + "bbox": { + "description": "Only features that have a geometry that intersects the bounding box are selected.\r\nThe bounding box is provided as four numbers. The coordinate reference system of the values is WGS84 longitude/latitude.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "featureIds": { + "description": "Array of feature ids to return.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SearchFeaturesResponse": { + "description": "Paged response contains list of features and next property to get the next set of results.", + "required": [ + "features" + ], + "type": "object", + "properties": { + "features": { + "description": "List of features.", + "type": "array", + "items": { + "$ref": "#/definitions/StacFeature" + } + }, + "nextLink": { + "description": "URL to do the POST request with same filters,\r\nto get next set of features.", + "type": "string", + "readOnly": true + } + } + }, + "SearchFieldQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "farmIds": { + "description": "FarmIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + } + } + }, + "SearchHarvestDataQuery": { + "description": "SearchHarvestDataQuery.", + "type": "object", + "properties": { + "minTotalYield": { + "format": "double", + "description": "Minimum Yield value(inclusive).", + "type": "number" + }, + "maxTotalYield": { + "format": "double", + "description": "Maximum Yield value (inclusive).", + "type": "number" + }, + "minAvgYield": { + "format": "double", + "description": "Minimum AvgYield value(inclusive).", + "type": "number" + }, + "maxAvgYield": { + "format": "double", + "description": "Maximum AvgYield value (inclusive).", + "type": "number" + }, + "minTotalWetMass": { + "format": "double", + "description": "Minimum Total WetMass value(inclusive).", + "type": "number" + }, + "maxTotalWetMass": { + "format": "double", + "description": "Maximum Total WetMass value (inclusive).", + "type": "number" + }, + "minAvgWetMass": { + "format": "double", + "description": "Minimum AvgWetMass value(inclusive).", + "type": "number" + }, + "maxAvgWetMass": { + "format": "double", + "description": "Maximum AvgWetMass value (inclusive).", + "type": "number" + }, + "minAvgMoisture": { + "format": "double", + "description": "Minimum AvgMoisture value(inclusive).", + "type": "number" + }, + "maxAvgMoisture": { + "format": "double", + "description": "Maximum AvgMoisture value (inclusive).", + "type": "number" + }, + "minAvgSpeed": { + "format": "double", + "description": "Minimum AvgSpeed value(inclusive).", + "type": "number" + }, + "maxAvgSpeed": { + "format": "double", + "description": "Maximum AvgSpeed value (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchPlantTissueAnalysisQuery": { + "description": "Search All PlantTissueAnalysis and Search PlantTissueAnalyses parameters.", + "type": "object", + "properties": { + "fieldIds": { + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "seasonIds": { + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropProductIds": { + "description": "CropVariety Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropIds": { + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchPlantingDataQuery": { + "description": "SearchPlantingDataQuery.", + "type": "object", + "properties": { + "minAvgPlantingRate": { + "format": "double", + "description": "Minimum AvgPlantingRate value(inclusive).", + "type": "number" + }, + "maxAvgPlantingRate": { + "format": "double", + "description": "Maximum AvgPlantingRate value (inclusive).", + "type": "number" + }, + "minTotalMaterial": { + "format": "double", + "description": "Minimum TotalMaterial value(inclusive).", + "type": "number" + }, + "maxTotalMaterial": { + "format": "double", + "description": "Maximum TotalMaterial value (inclusive).", + "type": "number" + }, + "minAvgMaterial": { + "format": "double", + "description": "Minimum AvgMaterial value(inclusive).", + "type": "number" + }, + "maxAvgMaterial": { + "format": "double", + "description": "Maximum AvgMaterial value (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchPrescriptionQuery": { + "description": "Get Zones query parameters.", + "type": "object", + "properties": { + "prescriptionMapIds": { + "description": "Prescription Map Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "types": { + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "productCodes": { + "description": "Product Codes of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "productNames": { + "description": "Product Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "sources": { + "description": "Sources of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchSeasonalFieldQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "farmIds": { + "description": "FarmIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "fieldIds": { + "description": "FieldIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "seasonIds": { + "description": "SeasonIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropProductIds": { + "description": "CropProductIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropIds": { + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchTillageDataQuery": { + "description": "SearchTillageDataQuery.", + "type": "object", + "properties": { + "minTillageDepth": { + "format": "double", + "description": "Minimum measured tillage depth (inclusive).", + "type": "number" + }, + "maxTillageDepth": { + "format": "double", + "description": "Maximum measured tillage depth (inclusive).", + "type": "number" + }, + "minTillagePressure": { + "format": "double", + "description": "Minimum pressure applied to a tillage implement (inclusive).", + "type": "number" + }, + "maxTillagePressure": { + "format": "double", + "description": "Maximum pressure applied to a tillage implement (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchZoneQuery": { + "description": "Get Zones query parameters.", + "type": "object", + "properties": { + "types": { + "description": "Types of the Zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "managementZoneIds": { + "description": "ManagementZoneIds of the Zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "sources": { + "description": "Sources of the Zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "Season": { + "description": "Schema of season resource.", + "type": "object", + "properties": { + "startDateTime": { + "format": "date-time", + "description": "Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "year": { + "format": "int32", + "description": "Season year.", + "type": "integer" + }, + "geographicIdentifier": { + "description": "Geographic Identifier.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Season" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SeasonalField": { + "description": "Schema of seasonal field resource.", + "required": [ + "farmId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "farmId": { + "description": "Id of the associated Farm.", + "minLength": 1, + "type": "string" + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "seasonId": { + "description": "Id of the season it belongs to.", + "type": "string" + }, + "cropProductIds": { + "description": "CropProduct ids.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldMetaData": { + "description": "Schema of seasonal field resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "seasonId": { + "description": "Id of the season it belongs to.", + "type": "string" + }, + "cropProductIds": { + "description": "CropProduct ids.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SeasonalFieldMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "Sensor": { + "description": "Sensor API model.", + "type": "object", + "properties": { + "sensorDataModelId": { + "description": "Id of the associated sensor data model.", + "type": "string" + }, + "integrationId": { + "description": "Integration id for the device.", + "type": "string" + }, + "hardwareId": { + "description": "Id of the associated hardware.", + "type": "string" + }, + "deviceId": { + "description": "Id of the associated device.", + "type": "string" + }, + "type": { + "description": "Type of sensor.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "port": { + "$ref": "#/definitions/Port" + }, + "depthInMeters": { + "description": "Depth of each sensor measure in meters.\r\nLike sensor moisture at 2m, 4m, 6m.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorDataModel": { + "description": "SensorModel API model.", + "required": [ + "measures" + ], + "type": "object", + "properties": { + "type": { + "description": "Type of sensor.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "manufacturer": { + "description": "Sensor manufacturer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productCode": { + "description": "Sensor productCode.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measures": { + "description": "Map of sensor type to sensor measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SensorDataModelMeasure" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorDataModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorDataModelMeasure": { + "description": "Sensor model measure details.", + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description of sensor measure.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "dataType": { + "description": "Sensor measure data type.", + "maxLength": 100, + "minLength": 2, + "enum": [ + "Bool", + "Double", + "DateTime", + "Long", + "String" + ], + "type": "string", + "x-ms-enum": { + "name": "SensorDataType", + "modelAsString": true + } + }, + "type": { + "description": "Measurement type of sensor data.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "unit": { + "description": "Unit of sensor measure.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs for sensor data model.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a model and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "SensorEvent": { + "description": "Sensor event response model.", + "type": "object", + "properties": { + "sensorId": { + "description": "Id of the sensor.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the sensor partner.", + "type": "string" + }, + "partyId": { + "description": "Id of the associated party.", + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "eventDateTime": { + "format": "date-time", + "description": "DateTime of sensor event observation.", + "type": "string" + }, + "ingestionDateTime": { + "format": "date-time", + "description": "DateTime of sensor event ingestion to data store.", + "type": "string" + }, + "measures": { + "description": "Sensor measures.", + "type": "object", + "additionalProperties": {} + } + } + }, + "SensorEventListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorEvent" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Sensor" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorMapping": { + "description": "SensorMapping API model.", + "required": [ + "associatedResource" + ], + "type": "object", + "properties": { + "sensorId": { + "description": "Id of the associated sensor.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string" + }, + "partyId": { + "description": "Id of the associated party.", + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorMappingListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorMapping" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorPartnerIntegrationCheckConsentResponse": { + "description": "Sensor partner integration check consent response.", + "type": "object", + "properties": { + "consented": { + "description": "Flag to determine the status of partner integration consent.", + "type": "boolean" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "integrationId": { + "description": "Id of the integration.", + "type": "string", + "readOnly": true + } + } + }, + "SensorPartnerIntegrationGenerateConsentLinkResponse": { + "description": "Sensor partner integration generate consent link response.", + "type": "object", + "properties": { + "consentLink": { + "description": "Consent link.", + "type": "string", + "readOnly": true + }, + "consentExpiryDateTime": { + "format": "date-time", + "description": "Consent expiry date time, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + } + } + }, + "SensorPartnerIntegrationModel": { + "description": "Sensor partner integration model.", + "type": "object", + "properties": { + "integrationId": { + "description": "Id of the integration.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "Id of the party.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorPartnerIntegrationModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorPlacementModelJob": { + "description": "Schema of sensor placement model job.", + "required": [ + "associatedResource", + "inferenceEndDateTime", + "inferenceStartDateTime", + "isRanked", + "modelVersion", + "partyId", + "satelliteProvider", + "satelliteSource", + "sensorType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "modelVersion": { + "description": "The version of the sensor placement model to be run.", + "minLength": 1, + "type": "string" + }, + "inferenceStartDateTime": { + "format": "date-time", + "description": "Start datetime for satellite data to be pulled.", + "type": "string" + }, + "inferenceEndDateTime": { + "format": "date-time", + "description": "End datetime for satellite data to be pulled.", + "type": "string" + }, + "satelliteProvider": { + "description": "Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise).", + "minLength": 1, + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "satelliteSource": { + "description": "Source of satellite data. Available Value: Sentinel_2_L2A.", + "minLength": 1, + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "sensorType": { + "description": "SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture.", + "minLength": 1, + "type": "string" + }, + "isRanked": { + "description": "IsRanked, if True the sensor placements will be ranked.", + "type": "boolean" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorRenewConnectionStringModel": { + "description": "Model for renewing sensor's connection string.", + "required": [ + "connectionStringType" + ], + "type": "object", + "properties": { + "connectionStringType": { + "description": "Specifies the type of connection string key to be renewed valid values - Primary/Secondary/Both.", + "maxLength": 100, + "minLength": 0, + "enum": [ + "Primary", + "Secondary", + "Both" + ], + "type": "string", + "x-ms-enum": { + "name": "RenewConnectionStringType", + "modelAsString": true + } + } + } + }, + "SoilMoistureModelJob": { + "description": "Schema of soil moisture model job.", + "required": [ + "associatedResource", + "imageFormat", + "imageResolution", + "inferenceEndDateTime", + "inferenceStartDateTime", + "modelVersion", + "partyId", + "satelliteProvider", + "satelliteSource", + "sensorDataModelId", + "sensorDefinition", + "sensorPartnerId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "sensorDataModelId": { + "description": "Sensor data model Id.", + "minLength": 1, + "type": "string" + }, + "sensorPartnerId": { + "description": "Sensor partner Id.", + "minLength": 1, + "type": "string" + }, + "inferenceStartDateTime": { + "format": "date-time", + "description": "Inference start date time for soil moisture calculations.", + "type": "string" + }, + "inferenceEndDateTime": { + "format": "date-time", + "description": "Inference end date time for soil moisture calculations.", + "type": "string" + }, + "satelliteProvider": { + "description": "Provider of satellite data. Available Value: Microsoft, SentinelHub (Sentinel Hub by Sinergise).", + "minLength": 1, + "enum": [ + "Microsoft", + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "satelliteSource": { + "description": "Source of satellite data. Available Value: Sentinel_2_L2A.", + "minLength": 1, + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "imageResolution": { + "format": "double", + "description": "ImageResolution in meters. Available values: 10, 20, 60.", + "type": "number" + }, + "imageFormat": { + "description": "ImageFormat. Available value: TIF.", + "minLength": 1, + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "modelVersion": { + "description": "The version of the soil moisture model to be run.", + "minLength": 1, + "type": "string" + }, + "sensorDefinition": { + "$ref": "#/definitions/SoilMoistureModelSensorDefinition" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SoilMoistureModelSensorDefinition": { + "description": "Schema for storing sensor definition keywords.", + "required": [ + "maxProperty", + "minProperty", + "sensorMeasurement" + ], + "type": "object", + "properties": { + "sensorMeasurement": { + "description": "The measurement name for sensor measure in sensorDataModel.", + "minLength": 1, + "type": "string" + }, + "minProperty": { + "description": "The measurement name for minimum measurement value.", + "minLength": 1, + "type": "string" + }, + "maxProperty": { + "description": "The measurement name for maximum measurement value.", + "minLength": 1, + "type": "string" + } + } + }, + "SolutionInference": { + "description": "SolutionInference request model.", + "required": [ + "requestPath" + ], + "type": "object", + "properties": { + "requestPath": { + "description": "RequestPath containing the api-version, query parameters and path route to be called for partner request.\r\nExpected format is \"/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1\".\r\nNot following this format may result into validation errors.", + "minLength": 1, + "type": "string" + }, + "partnerRequestBody": { + "description": "Api input parameters required by partner to trigger/cancel job request.", + "type": "object", + "additionalProperties": {} + } + } + }, + "Source": { + "description": "Source of satellite data.", + "enum": [ + "Sentinel_2_L2A", + "Sentinel_2_L1C" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "StacFeature": { + "description": "Schema of STAC Feature(Item).\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#item-fields.", + "required": [ + "assets", + "id", + "links", + "properties", + "stacVersion", + "type" + ], + "type": "object", + "properties": { + "stacVersion": { + "description": "The STAC version the Feature implements.", + "minLength": 1, + "type": "string" + }, + "stacExtensions": { + "description": "A list of extensions the Feature implements.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Provider identifier. Globally unique ID by Data provider.", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Type of the GeoJSON Object. It's value is always Feature.", + "minLength": 1, + "type": "string" + }, + "geometry": { + "description": "Defines the full footprint of the asset represented by this item.\r\nIts a GeoJSON geometry.", + "type": "object" + }, + "bbox": { + "description": "Bounding box of the feature.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "properties": { + "description": "A dictionary of additional metadata for the item.", + "type": "object" + }, + "links": { + "description": "List of link objects to resources and related URLs.", + "type": "array", + "items": { + "$ref": "#/definitions/StacFeatureLink" + } + }, + "assets": { + "description": "Dictionary of asset objects, each with a unique key.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StacFeatureAsset" + } + }, + "collection": { + "description": "The id of the STAC Collection this Feature references.", + "type": "string" + } + } + }, + "StacFeatureAsset": { + "description": "Schema of STAC Feature's Asset.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#asset-object.", + "required": [ + "href" + ], + "type": "object", + "properties": { + "href": { + "description": "Link to the asset object.", + "minLength": 1, + "type": "string" + }, + "title": { + "description": "The displayed title for clients and users.", + "type": "string" + }, + "description": { + "description": "A description of the Asset providing additional details, such as how it was processed or created.", + "type": "string" + }, + "type": { + "description": "Media type of the asset.", + "type": "string" + }, + "roles": { + "description": "The semantic roles of the asset, similar to the use of rel in links.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StacFeatureLink": { + "description": "The Link object describes a relationship of this Feature with another entity.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#link-object.", + "required": [ + "href", + "rel" + ], + "type": "object", + "properties": { + "href": { + "description": "The actual link in the format of an URL.", + "minLength": 1, + "type": "string" + }, + "rel": { + "description": "Relationship between the current document and the linked document.", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Media type of the referenced entity.", + "type": "string" + }, + "title": { + "description": "A human readable title to be used in rendered displays of the link.", + "type": "string" + } + } + }, + "TillageData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataMetaData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/TillageDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + }, + "WeatherDataErrors": { + "description": "Model for errors encountered for all failed locations.", + "type": "object", + "properties": { + "locations": { + "description": "List of errors encountered for all failed locations.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorForLocation" + } + } + } + }, + "WeatherDataForPassthrough": { + "description": "Schema of weather data.", + "type": "object", + "properties": { + "wetBulbTemperature": { + "$ref": "#/definitions/Measures" + }, + "cloudCover": { + "$ref": "#/definitions/Measures" + }, + "dayOfWeek": { + "description": "Day of week.", + "type": "array", + "items": { + "type": "string" + } + }, + "dayOrNight": { + "description": "This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTime": { + "description": "Expiration time in Utc format.", + "type": "array", + "items": { + "type": "string" + } + }, + "iconCode": { + "description": "This number is the key to the weather icon lookup. The data field shows the icon number that is matched to represent the observed weather conditions.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "iconCodeExtend": { + "description": "Code representing full set sensible weather.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "hasPrecipitation": { + "description": "Indicates whether there is precipitation or not.", + "type": "array", + "items": { + "type": "boolean" + } + }, + "pressureMeanSeaLevel": { + "$ref": "#/definitions/Measures" + }, + "relativeHumidity": { + "$ref": "#/definitions/Measures" + }, + "temperature": { + "$ref": "#/definitions/Measures" + }, + "temperatureDewPoint": { + "$ref": "#/definitions/Measures" + }, + "temperatureFeelsLike": { + "$ref": "#/definitions/Measures" + }, + "temperatureHeatIndex": { + "$ref": "#/definitions/Measures" + }, + "temperatureWindChill": { + "$ref": "#/definitions/Measures" + }, + "uvDescription": { + "description": "The UV Index Description which complements the UV Index value by providing an associated level of risk of skin damage due to exposure (-2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate, 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme).", + "type": "array", + "items": { + "type": "string" + } + }, + "uvIndex": { + "description": "Hourly maximum UV index.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "validTimeLocal": { + "description": "Time forecast is valid in local apparent time.", + "type": "array", + "items": { + "type": "string" + } + }, + "validTime": { + "description": "Time forecast is valid in Utc format.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "$ref": "#/definitions/Measures" + }, + "windDirection": { + "$ref": "#/definitions/Measures" + }, + "windGust": { + "$ref": "#/definitions/Measures" + }, + "windSpeed": { + "$ref": "#/definitions/Measures" + }, + "wxPhraseLong": { + "description": "Hourly sensible weather phrase containing longer description.", + "type": "array", + "items": { + "type": "string" + } + }, + "wxPhraseShort": { + "description": "Hourly sensible weather phrase containing short description.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalAttributes": { + "description": "A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 250 characters. Note: A maximum of 100 key value pairs can be provided for a resource and only string and numeral values are supported.", + "type": "object", + "additionalProperties": {} + } + } + }, + "WeatherDataProviderRequest": { + "description": "Schema of weather data provider request.", + "required": [ + "extensionApiName", + "extensionId", + "units" + ], + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ApiKeyAuthCredentials" + }, + "locations": { + "description": "List of locations for which weather data need to be fetched from the provider.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherLocation" + } + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "minLength": 1, + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "minLength": 1, + "type": "string" + }, + "language": { + "description": "Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'.", + "type": "string" + }, + "startTimeHours": { + "format": "int32", + "description": "Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "endTimeHours": { + "format": "int32", + "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.)", + "type": "integer" + }, + "units": { + "description": "Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units.", + "minLength": 1, + "type": "string" + }, + "additionalParams": { + "$ref": "#/definitions/AdditionalProviderParameters" + } + } + }, + "WeatherDataProviderResponse": { + "description": "Schema of Weather Data Provider Response.", + "required": [ + "weatherMetadata" + ], + "type": "object", + "properties": { + "weatherMetadata": { + "$ref": "#/definitions/WeatherMetadata" + }, + "status": { + "description": "Indicates a Succeeded, Failed, or PartiallySucceeded response.", + "enum": [ + "Succeeded", + "Failed", + "PartiallySucceeded" + ], + "type": "string", + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "locations": { + "description": "List of weather data for all the weather locations.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherLocationData" + } + }, + "errors": { + "$ref": "#/definitions/WeatherDataErrors" + } + } + }, + "WeatherLocation": { + "description": "Schema of Location data.", + "required": [ + "type", + "value" + ], + "type": "object", + "properties": { + "type": { + "description": "Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey.", + "maxLength": 25, + "minLength": 2, + "enum": [ + "LatLong", + "IataCode", + "IcaoCode", + "PlaceId", + "PostalKey" + ], + "type": "string", + "x-ms-enum": { + "name": "LocationType", + "modelAsString": true + } + }, + "value": { + "description": "Location Value eg. \"10,-25\" for LocationType Type \"LatLong\".", + "minLength": 1, + "type": "string" + } + } + }, + "WeatherLocationData": { + "description": "Schema of WeatherLocationData data.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/WeatherLocation" + }, + "requestCompletionTime": { + "description": "Request Completion Time in Utc of the location.", + "type": "string" + }, + "lastRefreshedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "data": { + "$ref": "#/definitions/WeatherDataForPassthrough" + } + } + }, + "WeatherMetadata": { + "description": "Schema of Weather Metadata.", + "required": [ + "extensionApiName", + "extensionId", + "extensionVersion", + "units", + "weatherDataType" + ], + "type": "object", + "properties": { + "extensionVersion": { + "description": "Version of the weather data extension.", + "minLength": 1, + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "minLength": 1, + "type": "string" + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "minLength": 1, + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "minLength": 1, + "type": "string" + }, + "language": { + "description": "Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'.", + "type": "string" + }, + "startTimeHours": { + "format": "int32", + "description": "Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "endTimeHours": { + "format": "int32", + "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.)", + "type": "integer" + }, + "units": { + "description": "Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units.", + "minLength": 1, + "type": "string" + }, + "additionalParams": { + "$ref": "#/definitions/AdditionalProviderParameters" + } + } + }, + "Zone": { + "description": "Api Model for Zone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the Zone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the Zone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "managementZoneId": { + "description": "Management Zone Id associated with the Zone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ZoneMetaData": { + "description": "Api Model for Zone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the Zone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the Zone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "managementZoneId": { + "description": "Management Zone Id associated with the Zone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ZoneMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ZoneMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "Bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before." + } + }, + "security": [ + { + "Bearer": [] + } + ] +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..48b8475142a9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "ApplicationData123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'ApplicationData' resource with id 'ApplicationData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "ApplicationData123", + "resourceType": "ApplicationData" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_CreateOrUpdate.json new file mode 100644 index 000000000000..8e8d14071936 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_CreateOrUpdate.json @@ -0,0 +1,257 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-07-01-preview", + "applicationData": { + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Delete.json new file mode 100644 index 000000000000..264b1ecfb3af --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Get.json new file mode 100644 index 000000000000..0d91a624f053 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Get.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2020-12-31T11:10:21Z", + "modifiedDateTime": "2020-12-31T11:10:21Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..17d460dffeac --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "ApplicationData123", + "resourceType": "ApplicationData" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Search.json new file mode 100644 index 000000000000..54617a7eade5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ApplicationData_Search.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchFarmOperationQuery": { + "minArea": 0, + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_CreateOrUpdate.json new file mode 100644 index 000000000000..da2c05e89eb3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-07-01-preview", + "file": "101010101" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Delete.json new file mode 100644 index 000000000000..defb86ac9e9e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Download.json new file mode 100644 index 000000000000..089129ae1098 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Get.json new file mode 100644 index 000000000000..7013dfebf032 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_ListByPartyId.json new file mode 100644 index 000000000000..a9c2f69eefc3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Attachments_ListByPartyId.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's attachment", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/attachments/{{attachmentId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_CreateOrUpdate.json new file mode 100644 index 000000000000..a2bcbacbc8ac --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_CreateOrUpdate.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "cropIds": [ + "CORN123" + ], + "cropProductId": "SEED123", + "cropProduct": { + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "cropIds": [ + "CORN123" + ], + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEED123", + "cropIds": [ + "CORN123" + ], + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_Delete.json new file mode 100644 index 000000000000..69176d27ee4d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "cropId": "CORN123", + "cropProductId": "SEED123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_Get.json new file mode 100644 index 000000000000..70fd08c8a1e3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "cropId": "CORN123", + "cropProductId": "SEED123" + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_List.json new file mode 100644 index 000000000000..b7caffe066e9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/CropProducts_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEED123", + "brand": "BRAND123", + "product": "AGTECH", + "trait": "string", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/crop-products/{{cropProductId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_CreateOrUpdate.json new file mode 100644 index 000000000000..8d33829a4fb1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_CreateOrUpdate.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "cropId": "CORN123", + "crop": { + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_Delete.json new file mode 100644 index 000000000000..e0107ee303a8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "cropId": "CORN123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_Get.json new file mode 100644 index 000000000000..99fd3d243e66 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "cropId": "CORN123" + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_List.json new file mode 100644 index 000000000000..c73fde91efc8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Crops_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_CreateOrUpdate.json new file mode 100644 index 000000000000..f3f28871b865 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124", + "api-version": "2023-07-01-preview", + "deviceDataModelObject": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "status": "new", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:52:16Z", + "eTag": "7f00bf76-0000-0700-0000-61ea82500000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_Delete.json new file mode 100644 index 000000000000..b7c87a59e5e0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_Get.json new file mode 100644 index 000000000000..583fea0c0774 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124" + }, + "responses": { + "200": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_List.json new file mode 100644 index 000000000000..dc18d3f262a0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/DeviceDataModels_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_CreateOrUpdate.json new file mode 100644 index 000000000000..c319fdc0f044 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceId": "d124", + "api-version": "2023-07-01-preview", + "deviceDetails": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "status": "new device", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d123", + "status": "new device", + "createdDateTime": "2022-01-24T06:20:47Z", + "modifiedDateTime": "2022-01-24T06:21:07Z", + "eTag": "0401a5cc-0000-0700-0000-61ee45540000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d123", + "status": "new device", + "createdDateTime": "2022-01-24T06:20:47Z", + "modifiedDateTime": "2022-01-24T06:20:47Z", + "eTag": "0401baca-0000-0700-0000-61ee453f0000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_Delete.json new file mode 100644 index 000000000000..98c922790bf6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceId": "d124", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_Get.json new file mode 100644 index 000000000000..2c9e4acda0b9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1", + "deviceId": "d124" + }, + "responses": { + "200": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d124", + "status": "new device", + "createdDateTime": "2022-01-24T06:22:41Z", + "modifiedDateTime": "2022-01-24T06:22:43Z", + "eTag": "04010fd5-0000-0700-0000-61ee45b30000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_List.json new file mode 100644 index 000000000000..f62c205dbab3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Devices_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d124", + "status": "new device", + "createdDateTime": "2022-01-24T06:22:41Z", + "modifiedDateTime": "2022-01-24T06:22:43Z", + "eTag": "04010fd5-0000-0700-0000-61ee45b30000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/FarmOperations_CreateDataIngestionJob.json new file mode 100644 index 000000000000..0c9877c30244 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/FarmOperations_CreateDataIngestionJob.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview", + "job": { + "partyId": "TEST-PARTY", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "startYear": 2012, + "name": "Farm Operations Job", + "description": "For TEST-PARTY", + "properties": { + "Operation": "All" + } + } + }, + "responses": { + "202": { + "body": { + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "durationInSeconds": 14.79, + "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7", + "status": "Waiting", + "message": "string", + "createdDateTime": "2021-03-15T07:14:14Z", + "lastActionDateTime": "2021-03-15T07:14:14Z", + "startTime": "2021-03-15T07:14:14Z", + "endTime": "2021-03-15T07:14:14Z", + "name": "Farm Operations Job", + "description": "For TEST-PARTY", + "properties": { + "Operation": "All" + }, + "partyId": "TEST-PARTY", + "authProviderId": "JOHNDEERE" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..eb84e838405b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "durationInSeconds": 11.2, + "id": "farm-operations-job", + "status": "Succeeded", + "message": "string", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "Farm operations Job", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "partyId": "PARTY123", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..d598a156961b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_CreateOrUpdate.json new file mode 100644 index 000000000000..3f439b759390 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-07-01-preview", + "farm": { + "status": "Active", + "name": "John Smith's Farm", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_Delete.json new file mode 100644 index 000000000000..4dc2df67d520 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_Get.json new file mode 100644 index 000000000000..484d14864c71 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "farmId": "FARM123" + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..96eeaf46dd45 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_List.json new file mode 100644 index 000000000000..0e3780560e7a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_ListByPartyId.json new file mode 100644 index 000000000000..cfd7e0df9b82 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Farms_ListByPartyId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/farms/{{farmId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..fcd8e89175f5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_CreateOrUpdate.json new file mode 100644 index 000000000000..85447a03eb56 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_CreateOrUpdate.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-07-01-preview", + "field": { + "farmId": "FARM123", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "status": "Active", + "name": "John Smith's Field", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Delete.json new file mode 100644 index 000000000000..0f8bfe2552f5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Get.json new file mode 100644 index 000000000000..b4d552d69c6a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "fieldId": "FIELD123" + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..baf6deca27c9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Search.json new file mode 100644 index 000000000000..2b71282f07ff --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Fields_Search.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchFieldQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..91dc906fc2bd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "harvestDataId": "HarvestData123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'harvestData' resource with id 'HarvestData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "HarvestData123", + "resourceType": "farmoperationharvestdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_CreateOrUpdate.json new file mode 100644 index 000000000000..52eae93b386c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_CreateOrUpdate.json @@ -0,0 +1,350 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123", + "harvestData": { + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Delete.json new file mode 100644 index 000000000000..b19890dbb3c7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Get.json new file mode 100644 index 000000000000..be0863d2685b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..aa858673b86b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 15, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "HarvestData123", + "resourceType": "farmoperationharvestdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Search.json new file mode 100644 index 000000000000..765199394e40 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/HarvestData_Search.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchFarmOperationQuery": { + "minArea": 0, + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ImageProcessing_CreateRasterizeJob.json new file mode 100644 index 000000000000..8eb7fe8f683c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ImageProcessing_CreateRasterizeJob.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview", + "job": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ] + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ], + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ImageProcessing_GetRasterizeJob.json new file mode 100644 index 000000000000..8d6a869510cc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ImageProcessing_GetRasterizeJob.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ], + "id": "string", + "status": "string", + "durationInSeconds": 15, + "message": "string", + "createdDateTime": "2021-05-03T08:51:04.744Z", + "lastActionDateTime": "2021-05-03T08:51:04.744Z", + "startTime": "2021-05-03T08:51:04.744Z", + "endTime": "2021-05-03T08:51:04.744Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_CreateOrUpdate.json new file mode 100644 index 000000000000..d6ab67d230d9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "partyId": "pjparty", + "modelId": "modelId", + "insightId": "insightId", + "insightAttachmentId": "insightAttachmentId", + "resourceId": "farmId", + "resourceType": "Farm", + "api-version": "2023-07-01-preview", + "body": { + "insightId": "insightId", + "resourceId": "farmId", + "resourceType": "Farm", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + }, + "responses": { + "200": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + }, + "201": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Delete.json new file mode 100644 index 000000000000..596948ba3da5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "partyId": "PARTY123", + "modelId": "modelId", + "insightAttachmentId": "insightAttachmentId", + "resourceId": "resourceId", + "resourceType": "Farm", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Download.json new file mode 100644 index 000000000000..92f29f078cc6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Download.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightAttachmentId": "ATTACHMENT123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Get.json new file mode 100644 index 000000000000..dadc7ad7ba8c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightAttachmentId": "insightAttachmentId" + }, + "responses": { + "200": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json new file mode 100644 index 000000000000..769b121f2521 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0c5729f8b32c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_CreateCascadeDeleteJob.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightId": "insightId", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_CreateOrUpdate.json new file mode 100644 index 000000000000..5b75babc774e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "partyId": "pjparty", + "modelId": "BiomassModelId", + "insightId": "insightId", + "resourceId": "farmId", + "resourceType": "Farm", + "api-version": "2023-07-01-preview", + "insightData": { + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54.043Z", + "insightEndDateTime": "2021-07-26T09:31:54.043Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_Delete.json new file mode 100644 index 000000000000..3264e5bb927a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "partyId": "PARTY123", + "modelId": "modelId", + "insightId": "insightId", + "resourceId": "resourceId", + "resourceType": "Farm", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_Get.json new file mode 100644 index 000000000000..f1952c297372 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightId": "insightId" + }, + "responses": { + "200": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..cb6f56eaa5c6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json new file mode 100644 index 000000000000..3264a0ce6683 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-06-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/insights?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..f3b47d647959 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "MANAGEMENTZONE123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "MANAGEMENTZONE123", + "resourceType": "managementzone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_CreateOrUpdate.json new file mode 100644 index 000000000000..8e0ed54bf631 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123", + "api-version": "2023-07-01-preview", + "managementZone": { + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "status": "Active", + "name": "John Smith's ManagementZone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_Delete.json new file mode 100644 index 000000000000..cfa40ed3b4be --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_Get.json new file mode 100644 index 000000000000..d6497296512d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d876cbd6a9c1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "MANAGEMENTZONE123", + "resourceType": "managementzone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_List.json new file mode 100644 index 000000000000..d71b35d3c675 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/management-zones?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_ListByPartyId.json new file mode 100644 index 000000000000..83d16876afbd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ManagementZones_ListByPartyId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/management-zones?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateBiomassModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateBiomassModelJob.json new file mode 100644 index 000000000000..bc6bb89aa676 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateBiomassModelJob.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview", + "job": { + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "cropName": "string", + "plantingStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "weatherExtensionId": "DTN.ClearAg", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF" + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "cropName": "string", + "plantingStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "weatherExtensionId": "DTN.ClearAg", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateSensorPlacementModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateSensorPlacementModelJob.json new file mode 100644 index 000000000000..70b8bf94ab92 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateSensorPlacementModelJob.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview", + "job": { + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorType": "SoilMoisture", + "isRanked": true + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorType": "SoilMoisture", + "isRanked": true, + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateSoilMoistureModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateSoilMoistureModelJob.json new file mode 100644 index 000000000000..eb017bcca1c2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_CreateSoilMoistureModelJob.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview", + "job": { + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "sensorDataModelId": "string", + "sensorPartnerId": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorDefinition": { + "sensorMeasurement": "string", + "minProperty": "string", + "maxProperty": "string" + }, + "imageResolution": 10, + "imageFormat": "TIF" + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "sensorDataModelId": "string", + "sensorPartnerId": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF", + "sensorDefinition": { + "sensorMeasurement": "string", + "minProperty": "string", + "maxProperty": "string" + }, + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetBiomassModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetBiomassModelJob.json new file mode 100644 index 000000000000..85497c5411d0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetBiomassModelJob.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 52.4, + "id": "biomass-job", + "status": "Succeeded", + "message": "Successfully calculated biomass feature in the given date range and created relevant Insight(s) and InsightAttachment(s).", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "cropName": "string", + "plantingStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "weatherExtensionId": "DTN.ClearAg", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "imageResolution": 10, + "imageFormat": "TIF" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetSensorPlacementModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetSensorPlacementModelJob.json new file mode 100644 index 000000000000..b87789e90cd8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetSensorPlacementModelJob.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 52.4, + "id": "sensor-placement-job", + "status": "Succeeded", + "message": "Successfully created sensor placement map for the given date range and created relevant Insight(s) and InsightAttachment(s).", + "createdDateTime": "2021-12-16T08:24:50Z", + "lastActionDateTime": "2021-12-16T08:24:50Z", + "startTime": "2021-12-16T08:24:50Z", + "endTime": "2021-12-16T08:24:50Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorType": "SoilMoisture", + "isRanked": true + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetSoilMoistureModelJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetSoilMoistureModelJob.json new file mode 100644 index 000000000000..d17919a61425 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/ModelInference_GetSoilMoistureModelJob.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 52.4, + "id": "biomass-job", + "status": "Succeeded", + "message": "Successfully calculated soil moisture feature in the given date range and created relevant Insight(s) and InsightAttachment(s).", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "partyId": "string", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "modelVersion": "string", + "sensorDataModelId": "string", + "sensorPartnerId": "string", + "inferenceStartDateTime": "2020-04-16T10:14:12Z", + "inferenceEndDateTime": "2020-09-16T10:14:12Z", + "satelliteProvider": "Microsoft", + "satelliteSource": "Sentinel_2_L2A", + "sensorDefinition": { + "sensorMeasurement": "string", + "minProperty": "string", + "maxProperty": "string" + }, + "imageResolution": 10, + "imageFormat": "TIF" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json new file mode 100644 index 000000000000..495be69a6a51 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123", + "api-version": "2023-07-01-preview", + "nutrientAnalysis": { + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "status": "Active", + "name": "John Smith's Nutrient Analysis", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_Delete.json new file mode 100644 index 000000000000..eb9fefbe2e0d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_Get.json new file mode 100644 index 000000000000..1c992a730bdd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_List.json new file mode 100644 index 000000000000..2ae32c07bcab --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/nutrient-analyses?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_ListByPartyId.json new file mode 100644 index 000000000000..bfeba06d4df1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/NutrientAnalyses_ListByPartyId.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's Nutrient analysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/nutrient-analyses?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..f82484b868a9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "oauthProviderId": "OAuthProvider123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "oauthProviderId": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthprovider' resource with id 'OAuthProvider123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_CreateOrUpdate.json new file mode 100644 index 000000000000..b8995d55cff7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-07-01-preview", + "oauthProvider": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + }, + "201": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_Delete.json new file mode 100644 index 000000000000..8492000469ec --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_Get.json new file mode 100644 index 000000000000..3dd709dbcbd1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Party": "123" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d6b196bcf826 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "oauthProviderId": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_List.json new file mode 100644 index 000000000000..2441e2f046c3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthProviders_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Party": "123" + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..ef1bf0613a04 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "oauthProviderId": "OAUTHPROVIDER123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'OAUTHPROVIDER123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "OAUTHPROVIDER123", + "resourceType": "oauthtokeninfo" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..e89c1c25e208 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "OAUTHPROVIDER123", + "resourceType": "oauthtokeninfo" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json new file mode 100644 index 000000000000..de655fadf92b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "oauthConnectRequest": { + "partyId": "PARTY123", + "oAuthProviderId": "JOHNDEERE", + "userRedirectLink": "https://docs.microsoft.com", + "userRedirectState": "code" + } + }, + "responses": { + "200": { + "body": "Connection string" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_List.json new file mode 100644 index 000000000000..6f892114bf96 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/OAuthTokens_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "authProviderId": "JOHNDEERE", + "isValid": true, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:49:25Z", + "modifiedDateTime": "2021-04-22T18:49:25Z" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..f3363b68042a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "party" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_CreateOrUpdate.json new file mode 100644 index 000000000000..55caa8ee840c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview", + "party": { + "status": "Active", + "name": "John Smith", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_Delete.json new file mode 100644 index 000000000000..11372424164c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_GeoOverlap.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_GeoOverlap.json new file mode 100644 index 000000000000..c3e11bb3b553 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_GeoOverlap.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "overlapResources": { + "resources": [ + { + "partyId": "PARTY123", + "resourceType": "Field", + "resourceId": "FIELD123" + }, + { + "partyId": "PARTY456", + "resourceType": "Field", + "resourceId": "FIELD456" + } + ] + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "resources": [ + { + "partyId": "PARTY123", + "resourceType": "Field", + "resourceId": "FIELD123", + "resourceArea": 35 + }, + { + "partyId": "PARTY456", + "resourceType": "Field", + "resourceId": "FIELD456", + "resourceArea": 25 + } + ], + "overlappingArea": 10 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_Get.json new file mode 100644 index 000000000000..2641dd263dab --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123" + }, + "responses": { + "200": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..8c17b6324f90 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "party" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_List.json new file mode 100644 index 000000000000..808f131d0514 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Parties_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..700349dbbcdf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PlantTissueAnalysis123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'planttissueanalysis' resource with id 'PlantTissueAnalysis123' and partyId 'PARTY123'.", + "createdDateTime": "2021-07-19T11:31:20Z", + "lastActionDateTime": "2021-07-19T11:31:34Z", + "startTime": "2021-07-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantTissueAnalysis123", + "resourceType": "planttissueanalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json new file mode 100644 index 000000000000..6c3aa96cd66d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSIS123", + "api-version": "2023-07-01-preview", + "plantTissueAnalysis": { + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2022-05-11T07:00:10Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "status": "Active", + "name": "John Smith's ManagementZone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Delete.json new file mode 100644 index 000000000000..421d3e838054 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSES123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Get.json new file mode 100644 index 000000000000..eface88c3704 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSES123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..e6001f57059d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-07-19T11:31:20Z", + "lastActionDateTime": "2021-07-19T11:31:34Z", + "startTime": "2021-07-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantTissueAnalysis123", + "resourceType": "planttissueanalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Search.json new file mode 100644 index 000000000000..1c3560452196 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantTissueAnalyses_Search.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchPlantTissueAnalysisQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..f959a4924eb5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantingDataId": "PlantingData123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'PlantingData' resource with id 'PlantingData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantingData123", + "resourceType": "farmoperationplantingdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_CreateOrUpdate.json new file mode 100644 index 000000000000..f74f3caa7e63 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_CreateOrUpdate.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123", + "plantingData": { + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Delete.json new file mode 100644 index 000000000000..cace04b99ea4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Get.json new file mode 100644 index 000000000000..adba54e8d19b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Get.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..3b5c8279b0ae --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantingData123", + "resourceType": "PlantingData" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Search.json new file mode 100644 index 000000000000..ab7f7996c1cc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PlantingData_Search.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchFarmOperationQuery": { + "minArea": 0, + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..dd41cd75f081 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTIONMAP123", + "resourceType": "prescriptionmap" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json new file mode 100644 index 000000000000..ad5300533db0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-07-01-preview", + "prescriptionMap": { + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "status": "Active", + "name": "John Smith's Prescription map", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_Delete.json new file mode 100644 index 000000000000..f33c2a4dd1fb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_Get.json new file mode 100644 index 000000000000..0d82a5cb0568 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123" + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..bbc944ae602b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTIONMAP123", + "resourceType": "prescriptionmap" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_List.json new file mode 100644 index 000000000000..48968e22fc4f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/prescription-maps?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_ListByPartyId.json new file mode 100644 index 000000000000..ae3872b0fe7a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/PrescriptionMaps_ListByPartyId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/prescription-maps?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..4340b7958277 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTION123", + "resourceType": "prescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..f6e8c5609560 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_CreateOrUpdate.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-07-01-preview", + "prescription": { + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "status": "Active", + "name": "John Smith's Prescription", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Delete.json new file mode 100644 index 000000000000..2112cf53c83e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Get.json new file mode 100644 index 000000000000..04089ebcbd2d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Get.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123" + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..67f41c66d34c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTION123", + "resourceType": "prescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Search.json new file mode 100644 index 000000000000..cdfeb730b269 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Prescriptions_Search.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchPrescriptionQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "Prescription123", + "prescriptionMapId": "PrescriptionMap123", + "type": "Nutrient rich", + "status": "Active", + "source": "Agronomist", + "name": "John Smith", + "description": "Some description", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json new file mode 100644 index 000000000000..bd4a1deb0cfe --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview", + "job": { + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "partyId": "PARTY123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "SentinelHub", + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "source": "Sentinel_2_L2A", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + }, + "properties": { + "Region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": 12.4, + "id": "satellite-job", + "status": "Created", + "message": "Created job 'satellite-job' to fetch satellite data for resource 'FIELD123' for startDate '01/01/2019 00:00:00' and endDate '03/30/2019 00:00:00' (both inclusive)", + "createdDateTime": "2021-04-16T07:56:05Z", + "lastActionDateTime": "2021-04-16T07:56:05Z", + "startDateTime": "2021-04-16T07:56:05Z", + "endDateTime": "2021-04-16T07:56:05Z", + "partyId": "PARTY123", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "string", + "keyName": "string", + "keyVersion": "string" + } + }, + "source": "Sentinel_2_L2A", + "provider": "SentinelHub", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_Download.json new file mode 100644 index 000000000000..5dbbc7b81b0c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_Download.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "filePath": "https://filePath", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json new file mode 100644 index 000000000000..398b22f665cd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 12.4, + "id": "satellite-job", + "status": "Succeeded", + "message": "Satellite data is available for 73 days from provider in the requested date range. Successfully fetched data for 73 days.", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "partyId": "PARTY123", + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_List.json new file mode 100644 index 000000000000..ef298de7f73c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_List.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "provider": "Microsoft", + "partyId": "PARTY123", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "source": "Sentinel_2_L2A", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "400e200f-ccc4-0cea-c120-3fdc6a41f99f", + "sceneDateTime": "2019-01-27T00:00:00Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "partyId": "PARTY123", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "cloudCoverPercentage": 67.2, + "darkPixelPercentage": 2.4, + "imageFormat": "TIF", + "imageFiles": [ + { + "name": "B08", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b08_10.tif" + }, + { + "name": "B03", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b03_10.tif" + }, + { + "name": "B11", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b11_10.tif" + }, + { + "name": "SNW", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/snw_10.tif" + }, + { + "name": "B05", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b05_10.tif" + }, + { + "name": "B06", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b06_10.tif" + }, + { + "name": "dataMask", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/datamask_10.tif" + }, + { + "name": "B07", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b07_10.tif" + }, + { + "name": "CLP", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/clp_10.tif" + }, + { + "name": "NDVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/ndvi_10.tif" + }, + { + "name": "SCL", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/scl_10.tif" + }, + { + "name": "B09", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b09_10.tif" + }, + { + "name": "B01", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b01_10.tif" + }, + { + "name": "NDWI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/ndwi_10.tif" + }, + { + "name": "AOT", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/aot_10.tif" + }, + { + "name": "CLD", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/cld_10.tif" + }, + { + "name": "CLM", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/clm_10.tif" + }, + { + "name": "B02", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b02_10.tif" + }, + { + "name": "B04", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b04_10.tif" + }, + { + "name": "B8A", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b8a_10.tif" + }, + { + "name": "EVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/evi_10.tif" + }, + { + "name": "B12", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-06-01-preview& filePath=microsoft/sentinel_2_l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b12_10.tif" + } + ] + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/scenes?provider=Microsoft&partyId=PARTY123&boundaryId=BOUNDARY123&api-version=2020-10-16-preview&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1PTnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAdOfBwAAAAAA7Z8HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_SearchFeatures.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_SearchFeatures.json new file mode 100644 index 000000000000..fe1255178686 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Scenes_SearchFeatures.json @@ -0,0 +1,449 @@ +{ + "parameters": { + "collectionId": "Sentinel_2_L2A", + "maxpagesize": 2, + "skip": 15, + "api-version": "2023-07-01-preview", + "searchFeaturesQuery": { + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "startDateTime": "2022-01-26T14:53:23.825Z", + "endDateTime": "2023-01-26T14:53:23.825Z", + "intersects": { + "type": "Polygon", + "coordinates": [ + [ + [ + 7.662878883920398, + 47.845905986476225 + ], + [ + 7.687601396600625, + 46.85818510350441 + ], + [ + 9.12804406196848, + 46.86563725992561 + ], + [ + 9.130456971517189, + 47.85361872819965 + ], + [ + 7.662878883920398, + 47.845905986476225 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "features": [ + { + "stacVersion": "0.9.0", + "stacExtensions": [ + "eo", + "projection" + ], + "id": "S2B_MSIL2A_20230121T102239_N0509_R065_T32UMU_20230121T113700", + "type": "Feature", + "geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:OGC::CRS84" + } + }, + "coordinates": [ + [ + [ + [ + 8.463630109874195, + 48.75175579972667 + ], + [ + 8.09718328627216, + 47.761624720018254 + ], + [ + 9.130235487170578, + 47.76510167563715 + ], + [ + 9.13276898152643, + 48.75292752793247 + ], + [ + 8.463630109874195, + 48.75175579972667 + ] + ] + ] + ] + }, + "bbox": [ + 8.09718328627216, + 47.761624720018254, + 9.13276898152643, + 48.75292752793247 + ], + "properties": { + "datetime": "2023-01-21T10:27:32Z", + "platform": "sentinel-2b", + "instruments": [ + "msi" + ], + "constellation": "sentinel-2", + "eo:gsd": 10, + "eo:cloud_cover": 80.46, + "eo:bands": [ + { + "name": "B01", + "common_name": "coastal", + "center_wavelength": 0.4427, + "full_width_half_max": 0.021 + }, + { + "name": "B02", + "common_name": "blue", + "center_wavelength": 0.4924, + "full_width_half_max": 0.066 + }, + { + "name": "B03", + "common_name": "green", + "center_wavelength": 0.5598, + "full_width_half_max": 0.036 + }, + { + "name": "B04", + "common_name": "red", + "center_wavelength": 0.6646, + "full_width_half_max": 0.031 + }, + { + "name": "B05", + "center_wavelength": 0.7041, + "full_width_half_max": 0.015 + }, + { + "name": "B06", + "center_wavelength": 0.7405, + "full_width_half_max": 0.015 + }, + { + "name": "B07", + "center_wavelength": 0.7828, + "full_width_half_max": 0.02 + }, + { + "name": "B08", + "common_name": "nir", + "center_wavelength": 0.8328, + "full_width_half_max": 0.106 + }, + { + "name": "B8A", + "common_name": "nir08", + "center_wavelength": 0.8647, + "full_width_half_max": 0.021 + }, + { + "name": "B09", + "common_name": "nir09", + "center_wavelength": 0.9451, + "full_width_half_max": 0.02 + }, + { + "name": "B11", + "common_name": "swir16", + "center_wavelength": 1.6137, + "full_width_half_max": 0.091 + }, + { + "name": "B12", + "common_name": "swir22", + "center_wavelength": 2.2024, + "full_width_half_max": 0.175 + } + ], + "proj:epsg": 32632, + "proj:bbox": [ + 399960, + 5290200, + 509760, + 5400000 + ], + "proj:geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:EPSG::32632" + } + }, + "coordinates": [ + [ + [ + [ + 460574.0276522319, + 5399999.00024835 + ], + [ + 432344.5418597979, + 5290201.00021934 + ], + [ + 509758.99999999994, + 5290201.000219454 + ], + [ + 509759, + 5399999.000248388 + ], + [ + 460574.0276522319, + 5399999.00024835 + ] + ] + ] + ] + } + }, + "links": [ + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a/items/S2B_MSIL2A_20230121T102239_N0509_R065_T32UMU_20230121T113700", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a", + "rel": "parent" + }, + { + "href": "https://scihub.copernicus.eu/dhus/odata/v1/Products('ece4b170-065b-4d3c-a005-9c20b8f383fe')/$value", + "rel": "derived_from", + "title": "scihub download" + } + ], + "assets": { + "thumbnail": { + "href": "https://roda.sentinel-hub.com/sentinel-s2-l1c/tiles/32/T/MT/2023/1/4/0/preview.jpg", + "title": "thumbnail", + "type": "image/png" + } + } + }, + { + "stacVersion": "0.9.0", + "stacExtensions": [ + "eo", + "projection" + ], + "id": "S2B_MSIL2A_20230121T102239_N0509_R065_T32UNU_20230121T113700", + "type": "Feature", + "geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:OGC::CRS84" + } + }, + "coordinates": [ + [ + [ + [ + 8.999741508947052, + 48.753004006975516 + ], + [ + 8.999746441483957, + 47.76517556280485 + ], + [ + 10.46477378099951, + 47.7558278091967 + ], + [ + 10.493255611543965, + 48.743328406398774 + ], + [ + 8.999741508947052, + 48.753004006975516 + ] + ] + ] + ] + }, + "bbox": [ + 8.999741508947052, + 47.7558278091967, + 10.493255611543965, + 48.753004006975516 + ], + "properties": { + "datetime": "2023-01-21T10:27:28Z", + "platform": "sentinel-2b", + "instruments": [ + "msi" + ], + "constellation": "sentinel-2", + "eo:gsd": 10, + "eo:cloud_cover": 95.46, + "eo:bands": [ + { + "name": "B01", + "common_name": "coastal", + "center_wavelength": 0.4427, + "full_width_half_max": 0.021 + }, + { + "name": "B02", + "common_name": "blue", + "center_wavelength": 0.4924, + "full_width_half_max": 0.066 + }, + { + "name": "B03", + "common_name": "green", + "center_wavelength": 0.5598, + "full_width_half_max": 0.036 + }, + { + "name": "B04", + "common_name": "red", + "center_wavelength": 0.6646, + "full_width_half_max": 0.031 + }, + { + "name": "B05", + "center_wavelength": 0.7041, + "full_width_half_max": 0.015 + }, + { + "name": "B06", + "center_wavelength": 0.7405, + "full_width_half_max": 0.015 + }, + { + "name": "B07", + "center_wavelength": 0.7828, + "full_width_half_max": 0.02 + }, + { + "name": "B08", + "common_name": "nir", + "center_wavelength": 0.8328, + "full_width_half_max": 0.106 + }, + { + "name": "B8A", + "common_name": "nir08", + "center_wavelength": 0.8647, + "full_width_half_max": 0.021 + }, + { + "name": "B09", + "common_name": "nir09", + "center_wavelength": 0.9451, + "full_width_half_max": 0.02 + }, + { + "name": "B11", + "common_name": "swir16", + "center_wavelength": 1.6137, + "full_width_half_max": 0.091 + }, + { + "name": "B12", + "common_name": "swir22", + "center_wavelength": 2.2024, + "full_width_half_max": 0.175 + } + ], + "proj:epsg": 32632, + "proj:bbox": [ + 499980, + 5290200, + 609780, + 5400000 + ], + "proj:geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:EPSG::32632" + } + }, + "coordinates": [ + [ + [ + [ + 499981, + 5399999.000248392 + ], + [ + 499981, + 5290201.000219455 + ], + [ + 609779.0000024929, + 5290201.000219092 + ], + [ + 609779.0000028561, + 5399999.000247997 + ], + [ + 499981, + 5399999.000248392 + ] + ] + ] + ] + } + }, + "links": [ + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a/items/S2B_MSIL2A_20230121T102239_N0509_R065_T32UNU_20230121T113700", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a", + "rel": "parent" + }, + { + "href": "https://scihub.copernicus.eu/dhus/odata/v1/Products('986643df-22f1-4c6b-be20-7db66ecbc699')/$value", + "rel": "derived_from", + "title": "scihub download" + } + ], + "assets": { + "thumbnail": { + "href": "https://roda.sentinel-hub.com/sentinel-s2-l1c/tiles/32/T/MT/2023/1/4/0/preview.jpg", + "title": "thumbnail", + "type": "image/png" + } + } + } + ], + "nextLink": "https://{{resourceName}}.farmbeats.azure.net//scenes/stac-collections/Sentinel_2_L2A:search?api-version={{apiVersion}}&maxpagesize=2&skip=17" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..9b800af16568 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_CreateOrUpdate.json new file mode 100644 index 000000000000..5faa45206311 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_CreateOrUpdate.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-07-01-preview", + "seasonalField": { + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Delete.json new file mode 100644 index 000000000000..5e23fc44b0e4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Get.json new file mode 100644 index 000000000000..ed43856c05e3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..216cfe4cf362 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Search.json new file mode 100644 index 000000000000..71ed384c6d0d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SeasonalFields_Search.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchSeasonalFieldQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_CreateOrUpdate.json new file mode 100644 index 000000000000..2cde0b4577ec --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_CreateOrUpdate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "seasonId": "SEASON123", + "season": { + "startDateTime": "2021-04-22T17:56:28Z", + "endDateTime": "2021-04-22T17:56:28Z", + "year": 2012, + "status": "Active", + "name": "John Smith's Season", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_Delete.json new file mode 100644 index 000000000000..9802e9fba34e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "seasonId": "SEASON123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_Get.json new file mode 100644 index 000000000000..3d85d7c8bdbc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "seasonId": "SEASON123" + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_List.json new file mode 100644 index 000000000000..c54a8c28fdea --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Seasons_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_CreateOrUpdate.json new file mode 100644 index 000000000000..128a794d7b2b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorDataModelId": "sdm124", + "api-version": "2023-07-01-preview", + "sensorDataModelObject": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "status": "new", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:15Z", + "eTag": "040158a0-0000-0700-0000-61ee433f0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_Delete.json new file mode 100644 index 000000000000..bd66f44f5698 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorDataModelId": "ddm124", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_Get.json new file mode 100644 index 000000000000..3d048fc4be97 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1", + "sensorDataModelId": "sdm124" + }, + "responses": { + "200": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_List.json new file mode 100644 index 000000000000..eaf48079ff94 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorDataModels_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorEvents_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorEvents_List.json new file mode 100644 index 000000000000..fa1988d100c3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorEvents_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorId": "S124", + "sensorPartnerId": "Davis", + "startDateTime": "2018-01-01T00:00:43Z", + "endDateTime": "2019-01-01T00:00:43Z", + "excludeDuplicateEvents": true + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "prbhad-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "eventDateTime": "2018-01-01T00:30:00Z", + "ingestionDateTime": "2021-09-20T05:56:09Z", + "measures": { + "soil_moisture": { + "unit": "m", + "value": 30.1 + } + } + }, + { + "partyId": "prbhad-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "eventDateTime": "2018-01-01T00:31:00Z", + "ingestionDateTime": "2021-09-20T05:56:09Z", + "measures": { + "soil_moisture": { + "unit": "m", + "value": 31.1 + } + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..f5ff4230c7cf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_CreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "sensorMappingId": "sm124", + "api-version": "2023-07-01-preview", + "sensorMappingObject": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "status": "sensor map created", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:40:48Z", + "eTag": "05018f35-0000-0700-0000-61ee49f00000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_Delete.json new file mode 100644 index 000000000000..6c27758ba85a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "sensorMappingId": "sm124", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_Get.json new file mode 100644 index 000000000000..5bf7c771e68c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorMappingId": "sm124" + }, + "responses": { + "200": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_List.json new file mode 100644 index 000000000000..485252235254 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorMappings_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json new file mode 100644 index 000000000000..ba61278d605a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "key": "CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8", + "body": {} + }, + "responses": { + "200": { + "body": { + "consented": true, + "sensorPartnerId": "Davis", + "integrationId": "I123" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json new file mode 100644 index 000000000000..34f70ef4b602 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "sensorPartnerIntegrationModel": { + "partyId": "prbhad-party", + "status": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-03-16T11:38:45Z", + "eTag": "73023740-0000-0700-0000-6231cc450000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2022-03-16T11:39:41Z", + "modifiedDateTime": "2022-03-16T11:39:41Z", + "eTag": "73023a53-0000-0700-0000-6231cc7d0000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_Delete.json new file mode 100644 index 000000000000..35113d3532d1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "Davis", + "integrationId": "I123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json new file mode 100644 index 000000000000..702c8e5e3546 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "body": {} + }, + "responses": { + "200": { + "body": { + "consentLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations/I123/:check-consent?key=CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8&apiVersion=2023-06-01-preview", + "consentExpiryDateTime": "2022-03-17T11:56:40Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_Get.json new file mode 100644 index 000000000000..a65cd0dc7da0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123" + }, + "responses": { + "200": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-03-16T11:38:45Z", + "eTag": "73023740-0000-0700-0000-6231cc450000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_List.json new file mode 100644 index 000000000000..4a5a3aa815d9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SensorPartnerIntegrations_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "sensorPartnerId": "Davis", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-01-04T11:17:08Z", + "eTag": "8900a6d8-0000-0700-0000-61d42cb40000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + }, + { + "integrationId": "I456", + "partyId": "prbhad-party2", + "sensorPartnerId": "Davis", + "id": "I456", + "status": "string", + "createdDateTime": "2022-01-12T10:33:54Z", + "modifiedDateTime": "2022-01-12T10:33:54Z", + "eTag": "8d014fe2-0000-0700-0000-61deae920000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations?maxPageSize=10&api-version=2023-06-01-preview&skipToken=W3sidG9rZW4iOiIrUklEOn4xQ1VyQU9zRU8zMXZucGdCQUFBQUFBPT0jUlQ6MSNUUkM6MTAjSVNWOjIjSUVPOjY1NTUxI1FDRjo0I0ZQQzpBZ0ppQm1JR1lnWUVBRytlRDRBPSIsInJhbmdlIjp7Im1pbiI6IiIsIm1heCI6IkZGIn19XQ" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_CreateOrUpdate.json new file mode 100644 index 000000000000..e4d39d2781cc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorId": "s124", + "api-version": "2023-07-01-preview", + "sensorDetails": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD 456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "status": "sm created", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:05Z", + "eTag": "040139eb-0000-0700-0000-61ee46b90000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:05Z", + "eTag": "040139eb-0000-0700-0000-61ee46b90000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_Delete.json new file mode 100644 index 000000000000..2010825c44d0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorId": "s124", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_Get.json new file mode 100644 index 000000000000..534d067396d8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124" + }, + "responses": { + "200": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:31Z", + "eTag": "04019fed-0000-0700-0000-61ee46d30000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_GetConnectionString.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_GetConnectionString.json new file mode 100644 index 000000000000..72d86437b6ab --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_GetConnectionString.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124", + "body": { + "connectionStringType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****", + "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_List.json new file mode 100644 index 000000000000..7d4f22bc00e6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:31Z", + "eTag": "04019fed-0000-0700-0000-61ee46d30000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_RenewConnectionString.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_RenewConnectionString.json new file mode 100644 index 000000000000..346eec6efd6e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Sensors_RenewConnectionString.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124", + "renewConnectionStringModel": { + "connectionStringType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****", + "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_Cancel.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_Cancel.json new file mode 100644 index 000000000000..1d43b05f2f3d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_Cancel.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "api-version": "2023-07-01-preview", + "solutionInferenceRequest": { + "requestPath": "string" + } + }, + "responses": { + "200": { + "body": { + "requestPath": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_CreateOrUpdate.json new file mode 100644 index 000000000000..7a340920aee2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_CreateOrUpdate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "api-version": "2023-07-01-preview", + "solutionInferenceRequest": { + "requestPath": "string" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "location" + }, + "body": { + "requestPath": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_Fetch.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_Fetch.json new file mode 100644 index 000000000000..878683981848 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/SolutionInference_Fetch.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "solutionInferenceRequest": { + "requestPath": "string" + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..fa0cb9503602 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "tillageDataId": "TillageData123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationtillagedata' resource with id 'TillageData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "TillageData123", + "resourceType": "farmoperationtillagedata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_CreateOrUpdate.json new file mode 100644 index 000000000000..8d067e07bbc5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_CreateOrUpdate.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123", + "tillageData": { + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Delete.json new file mode 100644 index 000000000000..3feeeeb28bcc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Get.json new file mode 100644 index 000000000000..c63576515add --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FIELD123" + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Asia", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..9b75fd27931d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "TillageData123", + "resourceType": "farmoperationtillagedata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Search.json new file mode 100644 index 000000000000..6d7a2bf2ca1c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/TillageData_Search.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchFarmOperationQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/WeatherData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/WeatherData_Get.json new file mode 100644 index 000000000000..625462d7e33e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/WeatherData_Get.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "weatherDataProviderRequest": { + "extensionId": "IBM.TWC", + "extensionApiName": "currents-on-demand", + "locations": [ + { + "type": "LatLong", + "value": "33,-97" + } + ], + "language": "en-US", + "units": "e", + "credentials": { + "kind": "ApiKeyAuthCredentials", + "apiKey": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + } + } + }, + "responses": { + "200": { + "body": { + "weatherMetadata": { + "extensionVersion": "1.0", + "weatherDataType": "current", + "extensionId": "IBM.TWC", + "extensionApiName": "currents-on-demand", + "units": "e" + }, + "status": "Succeeded", + "locations": [ + { + "location": { + "type": "LatLong", + "value": "33,-97" + }, + "lastRefreshedDateTime": "2023-02-09T13:02:20Z", + "data": { + "dayOfWeek": [ + "Wednesday" + ], + "dayOrNight": [ + "Night" + ], + "pressureMeanSeaLevel": { + "unit": "inches of mercury", + "values": [ + 1021.1 + ] + }, + "relativeHumidity": { + "unit": "percentage", + "values": [ + 84 + ] + }, + "temperature": { + "unit": "fahrenheit", + "values": [ + 49 + ] + }, + "temperatureDewPoint": { + "unit": "fahrenheit", + "values": [ + 44 + ] + }, + "temperatureFeelsLike": { + "unit": "fahrenheit", + "values": [ + 47 + ] + }, + "temperatureHeatIndex": { + "unit": "fahrenheit", + "values": [ + 49 + ] + }, + "temperatureWindChill": { + "unit": "fahrenheit", + "values": [ + 47 + ] + }, + "uvDescription": [ + "Low" + ], + "uvIndex": [ + 0 + ], + "visibility": { + "unit": "miles", + "values": [ + 10 + ] + }, + "windDirection": { + "unit": "degree", + "values": [ + 150 + ] + }, + "windGust": { + "unit": "miles/hour", + "values": [ + 0 + ] + }, + "windSpeed": { + "unit": "miles/hour", + "values": [ + 4 + ] + }, + "additionalAttributes": { + "cloudCoverPhrase": [ + "Partly Cloudy" + ] + } + } + } + ], + "errors": { + "locations": [] + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..940f38acda09 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "ZONE123", + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "ZONE123", + "resourceType": "zone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_CreateOrUpdate.json new file mode 100644 index 000000000000..dc785957a834 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_CreateOrUpdate.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "Zone123", + "api-version": "2023-07-01-preview", + "zone": { + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Delete.json new file mode 100644 index 000000000000..549ed048ad65 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "Zone123", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Get.json new file mode 100644 index 000000000000..6882cf07358c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "partyId": "PARTY123", + "zoneId": "Zone123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + }, + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..21c4bdcf10ca --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "ZONE123", + "resourceType": "zone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Search.json new file mode 100644 index 000000000000..067c363f0022 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-07-01-preview/examples/Zones_Search.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "maxPageSize": 50, + "skipToken": "string", + "searchZoneQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "source": "Agronomist", + "name": "John Smith", + "description": "Some description", + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/readme.md b/specification/agrifood/data-plane/readme.md index e46fff3a7125..a46038857b25 100644 --- a/specification/agrifood/data-plane/readme.md +++ b/specification/agrifood/data-plane/readme.md @@ -27,7 +27,7 @@ These are the global settings for the agfood. ```yaml openapi-type: data-plane -tag: package-2023-06-01-preview +tag: package-2023-07-01-preview directive: - suppress: LongRunningResponseStatusCode @@ -79,6 +79,15 @@ input-file: - Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json ``` +### Tag: package-2023-07-01-preview + +These settings apply only when `--tag=package-2023-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-07-01-preview' +input-file: + - Microsoft.AgFoodPlatform/preview/2023-07-01-preview/agfood.json +``` + # Code Generation ## Swagger to SDK diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/AmlServerless.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/AmlServerless.json new file mode 100644 index 000000000000..dee1db5b2b89 --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/AmlServerless.json @@ -0,0 +1,584 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AmlServerless", + "description": "These APIs allow end users to operate on Azure Machine Learning Serverless resources", + "version": "2021-10-01-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "modelPools" + } + ], + "paths": { + "/providers/Microsoft.AmlServerless/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AmlServerless/operation/{operationId}": { + "get": { + "operationId": "OperationStatus_Get", + "tags": [ + "OperationStatus" + ], + "description": "Get the status of an async operation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "operationId", + "in": "path", + "description": "The ID of the operation", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/operationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AmlServerless/modelPools/{modelPoolName}": { + "get": { + "operationId": "ModelPools_Get", + "tags": [ + "ModelPools" + ], + "description": "Get a modelPool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "modelPoolName", + "in": "path", + "description": "The name of the modelPool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/modelPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "ModelPools_CreateOrUpdate", + "tags": [ + "ModelPools" + ], + "description": "Create a modelPool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "modelPoolName", + "in": "path", + "description": "The name of the modelPool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/modelPoolProperties" + } + } + ], + "responses": { + "202": { + "description": "Resource create/update accepted.", + "schema": { + "$ref": "#/definitions/modelPoolCreateorUpdateOperation" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The tracking URI of the operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ModelPools_Update", + "tags": [ + "ModelPools" + ], + "description": "Update a modelPool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "modelPoolName", + "in": "path", + "description": "The name of the modelPool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/modelPoolUpdateProperties" + } + } + ], + "responses": { + "202": { + "description": "Resource update accepted.", + "schema": { + "$ref": "#/definitions/modelPoolUpdateOperation" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The tracking URI of the operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "ModelPools_Delete", + "tags": [ + "ModelPools" + ], + "description": "Delete a modelPool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "modelPoolName", + "in": "path", + "description": "The name of the modelPool", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "schema": { + "$ref": "#/definitions/modelPoolDeleteOperation" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The tracking URI of the operation." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Initial provisioning in progress" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Update in progress" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Change accepted for processing" + } + ] + } + }, + "operationStatus": { + "type": "object", + "description": "An object that represents an async operation status message", + "properties": { + "status": { + "type": "string", + "description": "The status of the operation" + }, + "modelPoolName": { + "type": "string", + "description": "The name of the model pool that the operation is associated with" + } + } + }, + "modelPoolCreateorUpdateOperation": { + "type": "object", + "description": "An object that represents an AmlServerless modelPool resource being newly created or updated", + "properties": { + "method": { + "type": "string", + "description": "" + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID passed as a parameter." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group passed as a parameter." + }, + "modelPoolName": { + "type": "string", + "description": "The name of the model pool." + }, + "properties": { + "$ref": "#/definitions/modelPoolProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "operationId": { + "type": "string", + "description": "The ID of the async operation being performed on the modelPool resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ] + }, + "modelPoolProperties": { + "type": "object", + "description": "Details of the AmlServerless modelPool.", + "properties": { + "partitionKey": { + "type": "string", + "description": "The name of the model pool." + }, + "rowKey": { + "type": "string", + "description": "The name of the model pool." + }, + "modelPoolId": { + "type": "string", + "description": "The name of the model pool." + }, + "modelAssetId": { + "type": "string", + "description": "The registry asset ID of the deployed model." + }, + "skuSize": { + "type": "string", + "description": "The size of the VM on which the pool is deployed." + }, + "workspaceAssetId": { + "type": "string", + "description": "The asset ID of backend AML workspace" + }, + "onlineEndpointName": { + "type": "string", + "description": "The name of the backend MIR online endpoint." + }, + "poolSize": { + "type": "integer", + "format": "int32", + "description": "The size of the pool." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of deployment instances." + }, + "location": { + "type": "string", + "description": "The location of the model pool." + }, + "etag": { + "type": "string", + "description": "The etag of the request." + }, + "timestamp": { + "type": "string", + "description": "The timestamp of the model pool resource." + }, + "tags": { + "type": "object", + "description": "Contains resource tags defined as key/value pairs.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "modelPoolUpdateOperation": { + "type": "object", + "description": "An object that represents an AmlServerless modelPool resource being updated.", + "properties": { + "method": { + "type": "string", + "description": "" + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID passed as a parameter." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group passed as a parameter." + }, + "modelPoolName": { + "type": "string", + "description": "The name of the model pool." + }, + "properties": { + "$ref": "#/definitions/modelPoolUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "operationId": { + "type": "string", + "description": "The ID of the async operation being performed on the modelPool resource." + } + } + }, + "modelPoolUpdateProperties": { + "type": "object", + "description": "The updatable properties of the modelPool.", + "properties": { + "modelAssetId": { + "type": "string", + "description": "The registry asset ID of the deployed model." + }, + "skuSize": { + "type": "string", + "description": "The size of the VM on which the pool is deployed." + }, + "poolSize": { + "type": "integer", + "format": "int32", + "description": "The size of the model pool." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of deployment instances." + }, + "tags": { + "type": "object", + "description": "Contains resource tags defined as key/value pairs.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "modelPoolDeleteOperation": { + "type": "object", + "description": "An object that represents an AmlServerless modelPool resource being deleted.", + "properties": { + "method": { + "type": "string", + "description": "" + }, + "subscriptionId": { + "type": "string", + "description": "The subscription ID passed as a parameter." + }, + "resourceGroup": { + "type": "string", + "description": "The resource group passed as a parameter." + }, + "modelPoolName": { + "type": "string", + "description": "The name of the model pool." + }, + "operationId": { + "type": "string", + "description": "The ID of the async operation being performed on the modelPool resource." + } + } + } + }, + "parameters": {} + } + \ No newline at end of file diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_CreateOrUpdate.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_CreateOrUpdate.json new file mode 100644 index 000000000000..0d508e4e5fe3 --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "title": "ModelPools_CreateOrUpdate", + "operationId": "ModelPools_CreateOrUpdate", + "parameters": { + "api-version": "2021-10-01-preview", + "subscriptionId": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "new-model-pool", + "resource": { + "properties": { + "ModelAssetId": "azureml://registries/azureml/models/t5-base/versions/8", + "SkuSize": "Standard_DS3_v2", + "PoolSize": 1, + "InstanceCount": 1, + "Location": "eastus", + "WorkspaceAssetID": "/subscriptions/subscription-id/resourceGroups/resource-group/providers/Microsoft.MachineLearningServices/workspaces/workspace", + "OnlineEndpointName": "endpoint-name", + "Tags": { + "testKey": "testValue" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscription-id/resourceGroups/resource-group/providers/Microsoft.AMLServerless/operations/operation-id?api-version=2023-10-01-preview" + }, + "body": { + "method": null, + "subscriptionID": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "new-model-pool", + "properties": { + "modelAssetId": "azureml://registries/azureml/models/t5-base/versions/8", + "skuSize": "Standard_DS3_v2", + "poolSize": 1, + "instanceCount": 1, + "location": "eastus", + "workspaceAssetID": "/subscriptions/subscription-id/resourceGroups/resource-group/providers/Microsoft.MachineLearningServices/workspaces/workspace", + "onlineEndpointName": "endpoint-name", + "tags": { + "testKey": "testValue" + } + }, + "operationID": "operation-id" + } + } + } +} \ No newline at end of file diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Delete.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Delete.json new file mode 100644 index 000000000000..08f16309797a --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Delete.json @@ -0,0 +1,24 @@ +{ + "title": "ModelPools_Delete", + "operationId": "ModelPools_Delete", + "parameters": { + "api-version": "2021-10-01-preview", + "subscriptionId": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "existing-model-pool" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscription-id/resourceGroups/resource-group/providers/Microsoft.AMLServerless/operations/operation-id?api-version=2023-10-01-preview" + }, + "body": { + "method": null, + "subscriptionID": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "existing-model-pool", + "operationID": "operation-id" + } + } + } +} \ No newline at end of file diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Get.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Get.json new file mode 100644 index 000000000000..3be166460e4f --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Get.json @@ -0,0 +1,28 @@ +{ + "title": "ModelPools_Get", + "operationId": "ModelPools_Get", + "parameters": { + "api-version": "2021-10-01-preview", + "subscriptionId": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "model-pool" + }, + "responses": { + "200": { + "body": { + "partitionKey": "model-pool", + "rowKey": "subscription-id:resource-group", + "modelPoolId": "79f21m10-f3u3-458f-9318-c1256190v814", + "modelAssetID": "azureml://registries/azureml/models/t5-base/versions/8", + "skuSize": "Standard_DS3_v2", + "workspaceAssetID": null, + "onlineEndpointName": "model-pool-r1c2-ep", + "poolSize": 1, + "instanceSize": 1, + "location": "eastus", + "eTag": "W/\"datetime'2023-08-04T04%3A25%3A54.1090305Z'\"", + "timestamp": "2023-08-04T04:25:54.1090305+00:00" + } + } + } +} \ No newline at end of file diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Update.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Update.json new file mode 100644 index 000000000000..38756fe8dcf3 --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/ModelPools_Update.json @@ -0,0 +1,44 @@ +{ + "title": "ModelPools_Update", + "operationId": "ModelPools_Update", + "parameters": { + "api-version": "2021-10-01-preview", + "subscriptionId": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "existing-model-pool", + "resource": { + "properties": { + "ModelAssetId": "azureml://registries/azureml/models/t5-small/versions/8", + "SkuSize": "Standard_DS2_v2", + "PoolSize": 2, + "InstanceCount": 2, + "Tags": { + "testKey2": "testValue2" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscription-id/resourceGroups/resource-group/providers/Microsoft.AMLServerless/operations/operation-id?api-version=2023-10-01-preview" + }, + "body": { + "method": null, + "subscriptionID": "subscription-id", + "resourceGroupName": "resource-group", + "modelPoolName": "existing-model-pool", + "properties": { + "modelAssetId": "azureml://registries/azureml/models/t5-small/versions/8", + "skuSize": "Standard_DS2_v2", + "poolSize": 2, + "instanceCount": 2, + "tags": { + "testKey2": "testValue2" + } + }, + "operationID": "operation-id" + } + } + } +} \ No newline at end of file diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/OperationStatus_Get.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..0054d1573491 --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/OperationStatus_Get.json @@ -0,0 +1,18 @@ +{ + "title": "OperationStatus_Get", + "operationId": "OperationStatus_Get", + "parameters": { + "api-version": "2021-10-01-preview", + "subscriptionId": "subscription-id", + "resourceGroupName": "resource-group", + "operationId": "operation-id" + }, + "responses": { + "200": { + "body": { + "status": "status", + "modelPoolName": "model-pool" + } + } + } + } \ No newline at end of file diff --git a/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/Operations_List.json b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..0d832ac6244f --- /dev/null +++ b/specification/amlserverless/resource-manager/Microsoft.AmlServerless/preview/2023-08-01-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2021-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ymeow", + "isDataAction": true, + "display": { + "provider": "qxyznq", + "resource": "bqfwkox", + "operation": "td", + "description": "yvgkhsuwartgxb" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "bamebrbqkebjwevbq" + } + } + } +} \ No newline at end of file diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json index 2ea10c4c5a6a..76a35318aaaa 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json @@ -1,168 +1,168 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "examplerg", - "environmentName": "testcontainerenv", - "api-version": "2022-11-01-preview", - "environmentEnvelope": { - "location": "East US", - "properties": { - "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string", - "sharedKey": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "dnsSuffix": "www.my-name.com", - "certificateValue": "Y2VydA==", - "certificatePassword": "1234" - }, - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", - "name": "testcontainerenv", - "type": "Microsoft.App/managedEnvironments", - "location": "East US", - "properties": { - "provisioningState": "Succeeded", - "deploymentErrors": null, - "defaultDomain": "testcontainerenv.k4apps.io", - "staticIp": "1.2.3.4", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "customDomainVerificationId": "custom domain verification id", - "dnsSuffix": "www.my-name.com", - "subjectName": "CN=www.my-name.com", - "expirationDate": "2022-11-06T04:00:00Z", - "thumbprint": "CERTIFICATE_THUMBPRINT" - }, - "eventStreamEndpoint": "testEndpoint", - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", - "name": "testcontainerenv", - "type": "Microsoft.App/managedEnvironments", - "location": "East US", - "properties": { - "provisioningState": "InitializationInProgress", - "deploymentErrors": null, - "defaultDomain": "testcontainerenv.k4apps.io", - "staticIp": "1.2.3.4", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "customDomainVerificationId": "custom domain verification id", - "dnsSuffix": "www.my-name.com", - "subjectName": "CN=www.my-name.com", - "expirationDate": "2022-11-06T04:00:00Z", - "thumbprint": "CERTIFICATE_THUMBPRINT" - }, - "eventStreamEndpoint": "testEndpoint", - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2022-11-01-preview", + "environmentEnvelope": { + "location": "East US", + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json index 550c10c505fa..0d7dd9485074 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json @@ -1,168 +1,168 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "examplerg", - "environmentName": "testcontainerenv", - "api-version": "2023-04-01-preview", - "environmentEnvelope": { - "location": "East US", - "properties": { - "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string", - "sharedKey": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "dnsSuffix": "www.my-name.com", - "certificateValue": "Y2VydA==", - "certificatePassword": "1234" - }, - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", - "name": "testcontainerenv", - "type": "Microsoft.App/managedEnvironments", - "location": "East US", - "properties": { - "provisioningState": "Succeeded", - "deploymentErrors": null, - "defaultDomain": "testcontainerenv.k4apps.io", - "staticIp": "1.2.3.4", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "customDomainVerificationId": "custom domain verification id", - "dnsSuffix": "www.my-name.com", - "subjectName": "CN=www.my-name.com", - "expirationDate": "2022-11-06T04:00:00Z", - "thumbprint": "CERTIFICATE_THUMBPRINT" - }, - "eventStreamEndpoint": "testEndpoint", - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", - "name": "testcontainerenv", - "type": "Microsoft.App/managedEnvironments", - "location": "East US", - "properties": { - "provisioningState": "InitializationInProgress", - "deploymentErrors": null, - "defaultDomain": "testcontainerenv.k4apps.io", - "staticIp": "1.2.3.4", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "customDomainVerificationId": "custom domain verification id", - "dnsSuffix": "www.my-name.com", - "subjectName": "CN=www.my-name.com", - "expirationDate": "2022-11-06T04:00:00Z", - "thumbprint": "CERTIFICATE_THUMBPRINT" - }, - "eventStreamEndpoint": "testEndpoint", - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2023-04-01-preview", + "environmentEnvelope": { + "location": "East US", + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json index 1c53366b9268..dd349ffbd172 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json @@ -1,168 +1,168 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "examplerg", - "environmentName": "testcontainerenv", - "api-version": "2023-05-01", - "environmentEnvelope": { - "location": "East US", - "properties": { - "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string", - "sharedKey": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "dnsSuffix": "www.my-name.com", - "certificateValue": "Y2VydA==", - "certificatePassword": "1234" - }, - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", - "name": "testcontainerenv", - "type": "Microsoft.App/managedEnvironments", - "location": "East US", - "properties": { - "provisioningState": "Succeeded", - "deploymentErrors": null, - "defaultDomain": "testcontainerenv.k4apps.io", - "staticIp": "1.2.3.4", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "customDomainVerificationId": "custom domain verification id", - "dnsSuffix": "www.my-name.com", - "subjectName": "CN=www.my-name.com", - "expirationDate": "2022-11-06T04:00:00Z", - "thumbprint": "CERTIFICATE_THUMBPRINT" - }, - "eventStreamEndpoint": "testEndpoint", - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", - "name": "testcontainerenv", - "type": "Microsoft.App/managedEnvironments", - "location": "East US", - "properties": { - "provisioningState": "InitializationInProgress", - "deploymentErrors": null, - "defaultDomain": "testcontainerenv.k4apps.io", - "staticIp": "1.2.3.4", - "appLogsConfiguration": { - "logAnalyticsConfiguration": { - "customerId": "string" - } - }, - "zoneRedundant": true, - "vnetConfiguration": { - "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" - }, - "customDomainConfiguration": { - "customDomainVerificationId": "custom domain verification id", - "dnsSuffix": "www.my-name.com", - "subjectName": "CN=www.my-name.com", - "expirationDate": "2022-11-06T04:00:00Z", - "thumbprint": "CERTIFICATE_THUMBPRINT" - }, - "eventStreamEndpoint": "testEndpoint", - "workloadProfiles": [ - { - "name": "My-GP-01", - "workloadProfileType": "GeneralPurpose", - "minimumCount": 3, - "maximumCount": 12 - }, - { - "name": "My-MO-01", - "workloadProfileType": "MemoryOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-CO-01", - "workloadProfileType": "ComputeOptimized", - "minimumCount": 3, - "maximumCount": 6 - }, - { - "name": "My-consumption-01", - "workloadProfileType": "Consumption" - } - ], - "infrastructureResourceGroup": "myInfrastructureRgName" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2023-05-01", + "environmentEnvelope": { + "location": "East US", + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json index e7dfbc89d475..de1306e0dae4 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", - "api-version": "2020-06-14", - "parameters": { - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "kustodatabase", - "defaultPrincipalsModificationKind": "Union" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Creating" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Creating" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-06-14", + "parameters": { + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "kustodatabase", + "defaultPrincipalsModificationKind": "Union" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json index dd57033e26c5..dc74cce253fb 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json index 55e7468e060b..be5eca0f5228 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "databaseName": "*", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "databaseName": "*", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json index d03ad4e69fc1..099275b23471 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase9", - "name": "KustoClusterRPTest4/KustoDatabase9", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json index 714b2de30e42..6c26e4278d03 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14", - "languageExtensionsToAdd": { - "value": [ - { - "languageExtensionName": "PYTHON" - }, - { - "languageExtensionName": "R" - } - ] - } - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "languageExtensionsToAdd": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json index f45bcf4f54b3..1c16c2fd4b1a 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14", - "followerDatabaseToRemove": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4", - "attachedDatabaseConfigurationName": "myAttachedDatabaseConfiguration" - } - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "followerDatabaseToRemove": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4", + "attachedDatabaseConfigurationName": "myAttachedDatabaseConfiguration" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json index 372ed1fed327..d4c5be7ecdc7 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "attachedDatabaseConfigurationName": "attachedDbConfiguration", - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1", - "databaseName": "*" - }, - { - "attachedDatabaseConfigurationName": "attachedDbConfiguration2", - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4", - "databaseName": "db1" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "attachedDatabaseConfigurationName": "attachedDbConfiguration", + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1", + "databaseName": "*" + }, + { + "attachedDatabaseConfigurationName": "attachedDbConfiguration2", + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4", + "databaseName": "db1" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json index 6581203981d9..2cb7975fcccd 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "languageExtensionName": "PYTHON" - }, - { - "languageExtensionName": "R" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json index c86831b19e09..c673add5080f 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": { - "name": "kustoprincipal1", - "type": "Microsoft.Kusto/clusters/principalAssignments" - }, - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "name": "kustoprincipal1", - "nameAvailable": false, - "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": { + "name": "kustoprincipal1", + "type": "Microsoft.Kusto/clusters/principalAssignments" + }, + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "name": "kustoprincipal1", + "nameAvailable": false, + "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json index 5be64e6e3e46..af1763ceb229 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json @@ -1,51 +1,51 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-06-14", - "parameters": { - "properties": { - "role": "AllDatabasesAdmin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14", + "parameters": { + "properties": { + "role": "AllDatabasesAdmin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json index eec31255f447..73962f811de2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json index 13737e053f15..7168f26d59eb 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json index b1b71083aa78..378cdd4a8d3b 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json @@ -1,45 +1,45 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json index b66521becf23..1b4ef4557fd2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14", - "languageExtensionsToRemove": { - "value": [ - { - "languageExtensionName": "PYTHON" - }, - { - "languageExtensionName": "R" - } - ] - } - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "languageExtensionsToRemove": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json index 29f8da9d1654..e06131ed4bec 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "api-version": "2020-06-14", - "location": "wus", - "clusterName": { - "name": "kustoclusterrptest4", - "type": "Microsoft.Kusto/clusters" - } - }, - "responses": { - "200": { - "body": { - "name": "kuskusprod", - "nameAvailable": false, - "message": "Name 'kuskusprod' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-06-14", + "location": "wus", + "clusterName": { + "name": "kustoclusterrptest4", + "type": "Microsoft.Kusto/clusters" + } + }, + "responses": { + "200": { + "body": { + "name": "kuskusprod", + "nameAvailable": false, + "message": "Name 'kuskusprod' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json index 5065c3af67e8..329d7530096f 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json @@ -1,86 +1,86 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14", - "parameters": { - "location": "westus", - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "enableStreamingIngest": true, - "enablePurge": true, - "enableDoubleEncryption": false - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "enableDoubleEncryption": false, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "enableDoubleEncryption": false, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "parameters": { + "location": "westus", + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json index 635552d1cbc1..ea477f07fc88 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json index 197a3f05f496..705879ea4d21 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "findings": [ - "Outbound dependency 'Storage:443' might not be satisfied (Outbound)" - ] - } - }, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "findings": [ + "Outbound dependency 'Storage:443' might not be satisfied (Outbound)" + ] + } + }, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json index 44892ca5acf3..17b4e7c816bb 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": false, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json index 88284a960b25..091710fbd737 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", - "name": "KustoClusterRPTest3", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json index 0108b9372831..9fd32ddd015c 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", - "name": "KustoClusterRPTest3", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json index 44ade5876d50..33c899b7c486 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json @@ -1,68 +1,68 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "resourceType": "clusters", - "sku": { - "name": "Standard_D13_v2", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - }, - { - "resourceType": "clusters", - "sku": { - "name": "Standard_D14_v2", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - }, - { - "resourceType": "clusters", - "sku": { - "name": "Standard_L8s", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - }, - { - "resourceType": "clusters", - "sku": { - "name": "Standard_L16s", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "clusters", + "sku": { + "name": "Standard_D13_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_D14_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_L8s", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_L16s", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json index 9c44eecbf557..d78993e52803 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json @@ -1,103 +1,103 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Standard_D13_v2", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - }, - { - "name": "Standard_D14_v2", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - }, - { - "name": "L8", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - }, - { - "name": "L16", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_D13_v2", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "Standard_D14_v2", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "L8", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "L16", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json index 13eb4ac881c3..f2fb9462c0d8 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json index 13eb4ac881c3..f2fb9462c0d8 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json index 3c5d33b762f3..9c0cb1c986b1 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json @@ -1,107 +1,107 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14", - "parameters": { - "location": "westus" - }, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "enableStreamingIngest": true, - "enablePurge": true, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - } - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "parameters": { + "location": "westus" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json index 0cc43d24d15d..91c82712144d 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "parameters": { - "dataConnectionName": "DataConnections8", - "properties": { - "kind": "EventHub", - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "responses": { - "200": { - "body": [ - { - "errorMessage": "Event hub's namespace does not exist" - }, - { - "errorMessage": "Database does not exist" - } - ] - }, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "parameters": { + "dataConnectionName": "DataConnections8", + "properties": { + "kind": "EventHub", + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": [ + { + "errorMessage": "Event hub's namespace does not exist" + }, + { + "errorMessage": "Database does not exist" + } + ] + }, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json index 874c7fb9a8de..a892511dcb56 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "api-version": "2020-06-14", - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "dataConnectionName": { - "name": "DataConnections8", - "type": "Microsoft.Kusto/clusters/databases/dataConnections" - } - }, - "responses": { - "200": { - "body": { - "name": "DataConnections8", - "nameAvailable": false, - "message": "Name 'DataConnections8' is already taken. Please specify a different name.", - "reason": "AlreadyExists" - } - } - } -} +{ + "parameters": { + "api-version": "2020-06-14", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "dataConnectionName": { + "name": "DataConnections8", + "type": "Microsoft.Kusto/clusters/databases/dataConnections" + } + }, + "responses": { + "200": { + "body": { + "name": "DataConnections8", + "nameAvailable": false, + "message": "Name 'DataConnections8' is already taken. Please specify a different name.", + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json index d8f408b09135..0a0dd74906be 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json @@ -1,59 +1,59 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "dataConnectionName": "DataConnections8", - "parameters": { - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json index d8e12541ac64..3cb05bbfde80 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json @@ -1,15 +1,15 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "dataConnectionName": "kustoeventhubconnection1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "kustoeventhubconnection1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json index 4b6e6fc20dbe..8096fd1512c3 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "dataConnectionName": "DataConnections8" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "DataConnections8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json index ae066afb7e08..fa02f77a8a36 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8", - "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9", - "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2", - "consumerGroup": "testConsumerGroup2" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8", + "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9", + "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2", + "consumerGroup": "testConsumerGroup2" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json index d8f408b09135..0a0dd74906be 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json @@ -1,59 +1,59 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "dataConnectionName": "DataConnections8", - "parameters": { - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json index 76782e424a77..407013c3c5ff 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json @@ -1,69 +1,69 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "databasePrincipalsToAdd": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "databasePrincipalsToAdd": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json index 30ce44d15ecf..99a86fb13d32 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json index 786337cdc34d..3e19087e1647 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": { - "name": "kustoprincipal1", - "type": "Microsoft.Kusto/clusters/databases/principalAssignments" - }, - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "name": "kustoprincipal1", - "nameAvailable": false, - "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": { + "name": "kustoprincipal1", + "type": "Microsoft.Kusto/clusters/databases/principalAssignments" + }, + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "name": "kustoprincipal1", + "nameAvailable": false, + "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json index 3c805dbfde19..70979cf0fe30 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-06-14", - "parameters": { - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14", + "parameters": { + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json index cac1fe662991..dd31722d2f77 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json @@ -1,15 +1,15 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json index f68b3ef7496d..184866b87e91 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json index b1b71083aa78..378cdd4a8d3b 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json @@ -1,45 +1,45 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json index f4082621bcaf..98b2da77ca9b 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json @@ -1,69 +1,69 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "databasePrincipalsToRemove": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "databasePrincipalsToRemove": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json index 5726470601bb..0c44b8720760 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "api-version": "2020-06-14", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "resourceName": { - "name": "kustoresourcename1", - "type": "Microsoft.Kusto/clusters/databases" - } - }, - "responses": { - "200": { - "body": { - "name": "kustoresourcename1", - "nameAvailable": false, - "message": "Name 'kuskus' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-06-14", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "resourceName": { + "name": "kustoresourcename1", + "type": "Microsoft.Kusto/clusters/databases" + } + }, + "responses": { + "200": { + "body": { + "name": "kustoresourcename1", + "nameAvailable": false, + "message": "Name 'kuskus' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json index 76b9c8e81e96..6034c0ef65cc 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json @@ -1,57 +1,57 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "parameters": { - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "parameters": { + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json index 566a505547e7..a1142ecfe332 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json index 34b4e866b585..cf30b19eb46c 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json index 0d43e6b33f66..e8fc45a80cf2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9", - "name": "KustoClusterRPTest4/KustoDatabase9", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json index 4c36dd0a6038..739c7a8ff42a 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-06-14", - "parameters": { - "properties": { - "softDeletePeriod": "P1D" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "parameters": { + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json index 36ea112ce353..c8fba9fec093 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "api-version": "2020-06-14" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "operationName", - "display": { - "provider": "providerName", - "resource": "resourceName", - "operation": "operationName", - "description": "operation description" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "provider": "providerName", + "resource": "resourceName", + "operation": "operationName", + "description": "operation description" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json index 3cd7dcc2bc03..8f06ea9b6330 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", - "api-version": "2020-09-18", - "parameters": { - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "kustodatabase", - "defaultPrincipalsModificationKind": "Union" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Creating" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Creating" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-09-18", + "parameters": { + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "kustodatabase", + "defaultPrincipalsModificationKind": "Union" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json index b4d3053b2661..4fd2dc614767 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json index 9084959fe306..d5a20bb62559 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsGet.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1", - "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "databaseName": "*", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "databaseName": "*", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json index 486ab7459f31..3ad6051ff531 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoAttachedDatabaseConfigurationsListByCluster.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase9", - "name": "KustoClusterRPTest4/KustoDatabase9", - "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", - "location": "westus", - "properties": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", - "databaseName": "db1", - "defaultPrincipalsModificationKind": "Union", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json index 64fc755ae1fc..d3b79768d459 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterAddLanguageExtensions.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18", - "languageExtensionsToAdd": { - "value": [ - { - "languageExtensionName": "PYTHON" - }, - { - "languageExtensionName": "R" - } - ] - } - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18", + "languageExtensionsToAdd": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json index fa7219ff1b82..98efdfe4ffbf 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterDetachFollowerDatabases.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18", - "followerDatabaseToRemove": { - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4", - "attachedDatabaseConfigurationName": "myAttachedDatabaseConfiguration" - } - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18", + "followerDatabaseToRemove": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4", + "attachedDatabaseConfigurationName": "myAttachedDatabaseConfiguration" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json index f6fc5b64ce8a..2b94874483f1 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListFollowerDatabases.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "attachedDatabaseConfigurationName": "attachedDbConfiguration", - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1", - "databaseName": "*" - }, - { - "attachedDatabaseConfigurationName": "attachedDbConfiguration2", - "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4", - "databaseName": "db1" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "attachedDatabaseConfigurationName": "attachedDbConfiguration", + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1", + "databaseName": "*" + }, + { + "attachedDatabaseConfigurationName": "attachedDbConfiguration2", + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4", + "databaseName": "db1" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json index 32d0dabe8250..1d924b5e63ae 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterListLanguageExtensions.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "languageExtensionName": "PYTHON" - }, - { - "languageExtensionName": "R" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json index 28b8998c1008..d72198a54c56 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": { - "name": "kustoprincipal1", - "type": "Microsoft.Kusto/clusters/principalAssignments" - }, - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "name": "kustoprincipal1", - "nameAvailable": false, - "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": { + "name": "kustoprincipal1", + "type": "Microsoft.Kusto/clusters/principalAssignments" + }, + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "name": "kustoprincipal1", + "nameAvailable": false, + "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json index dd7571930885..b77bb8411502 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json @@ -1,51 +1,51 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-09-18", - "parameters": { - "properties": { - "role": "AllDatabasesAdmin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-09-18", + "parameters": { + "properties": { + "role": "AllDatabasesAdmin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json index 7f1ec1602d86..64448b9e67a1 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json index 21e5ab70c8f7..3931cd422ade 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsGet.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json index 080811fea6db..93966d2ddca2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterPrincipalAssignmentsList.json @@ -1,45 +1,45 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json index 6cdfd1e46b90..90fcbda92bf3 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClusterRemoveLanguageExtensions.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18", - "languageExtensionsToRemove": { - "value": [ - { - "languageExtensionName": "PYTHON" - }, - { - "languageExtensionName": "R" - } - ] - } - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18", + "languageExtensionsToRemove": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json index a2298cbd294e..0282988e0409 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCheckNameAvailability.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "api-version": "2020-09-18", - "location": "wus", - "clusterName": { - "name": "kustoclusterrptest4", - "type": "Microsoft.Kusto/clusters" - } - }, - "responses": { - "200": { - "body": { - "name": "kuskusprod", - "nameAvailable": false, - "message": "Name 'kuskusprod' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-09-18", + "location": "wus", + "clusterName": { + "name": "kustoclusterrptest4", + "type": "Microsoft.Kusto/clusters" + } + }, + "responses": { + "200": { + "body": { + "name": "kuskusprod", + "nameAvailable": false, + "message": "Name 'kuskusprod' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json index da62b0b8fabb..a52d13fed715 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersCreateOrUpdate.json @@ -1,88 +1,88 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18", - "parameters": { - "location": "westus", - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "enableStreamingIngest": true, - "enablePurge": true, - "enableDoubleEncryption": false - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "enableDoubleEncryption": false, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "enableDoubleEncryption": false, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18", + "parameters": { + "location": "westus", + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json index 07afa7145686..5a5bb7cb570f 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDelete.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json index 4d28dd726a9a..43309ec41030 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersDiagnoseVirtualNetwork.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "findings": [ - "Outbound dependency 'Storage:443' might not be satisfied (Outbound)" - ] - } - }, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "findings": [ + "Outbound dependency 'Storage:443' might not be satisfied (Outbound)" + ] + } + }, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json index 4eed52534e40..1c533d4b8a70 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersGet.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": false, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json index ae7841c260b0..bade6f3450ef 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersList.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", - "name": "KustoClusterRPTest3", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json index eb34b2c020ab..9213c1ee0045 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListByResourceGroup.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", - "name": "KustoClusterRPTest3", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json index e3068b3326cc..b6badf6aa162 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListResourceSkus.json @@ -1,68 +1,68 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "resourceType": "clusters", - "sku": { - "name": "Standard_D13_v2", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - }, - { - "resourceType": "clusters", - "sku": { - "name": "Standard_D14_v2", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - }, - { - "resourceType": "clusters", - "sku": { - "name": "Standard_L8s", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - }, - { - "resourceType": "clusters", - "sku": { - "name": "Standard_L16s", - "tier": "Standard" - }, - "capacity": { - "minimum": 2, - "maximum": 100, - "default": 2, - "scaleType": "automatic" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "clusters", + "sku": { + "name": "Standard_D13_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_D14_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_L8s", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_L16s", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json index 3ab882df762b..2a95ec5ef418 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersListSkus.json @@ -1,103 +1,103 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Standard_D13_v2", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - }, - { - "name": "Standard_D14_v2", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - }, - { - "name": "L8", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - }, - { - "name": "L16", - "tier": "Standard", - "locations": [ - "West US", - "West Europe" - ], - "locationInfo": [ - { - "location": "West US", - "zones": [ - "1", - "2", - "3" - ] - }, - { - "location": "West Europe", - "zones": [] - } - ] - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_D13_v2", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "Standard_D14_v2", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "L8", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "L16", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json index 980f22a32831..286ea5966dfd 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStart.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json index 980f22a32831..286ea5966dfd 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersStop.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json index b770f9d74a4b..84df44b1eca1 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoClustersUpdate.json @@ -1,111 +1,111 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18", - "parameters": { - "location": "westus" - }, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "enableStreamingIngest": true, - "enablePurge": true, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "keyVaultProperties": { - "keyVaultUri": "https://dummy.keyvault.com", - "keyName": "keyName", - "keyVersion": "keyVersion" - }, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", - "name": "KustoClusterRPTest4", - "type": "Microsoft.Kusto/Clusters", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "enableStreamingIngest": true, - "enablePurge": true, - "engineType": "V2" - }, - "sku": { - "name": "Standard_L8s", - "capacity": 2, - "tier": "Standard" - }, - "identity": { - "type": "SystemAssigned", - "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", - "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", - "userAssignedIdentities": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18", + "parameters": { + "location": "westus" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + }, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "engineType": "V2" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json index 2903d8f64139..c089553c5700 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCheckNameAvailability.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "api-version": "2020-09-18", - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "dataConnectionName": { - "name": "DataConnections8", - "type": "Microsoft.Kusto/clusters/databases/dataConnections" - } - }, - "responses": { - "200": { - "body": { - "name": "DataConnections8", - "nameAvailable": false, - "message": "Name 'DataConnections8' is already taken. Please specify a different name.", - "reason": "AlreadyExists" - } - } - } -} +{ + "parameters": { + "api-version": "2020-09-18", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "dataConnectionName": { + "name": "DataConnections8", + "type": "Microsoft.Kusto/clusters/databases/dataConnections" + } + }, + "responses": { + "200": { + "body": { + "name": "DataConnections8", + "nameAvailable": false, + "message": "Name 'DataConnections8' is already taken. Please specify a different name.", + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json index 1fb8d3788065..88028923b7c6 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsCreateOrUpdate.json @@ -1,59 +1,59 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "dataConnectionName": "DataConnections8", - "parameters": { - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json index 05a772ff4ed3..b5933e9a43e2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsDelete.json @@ -1,15 +1,15 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "dataConnectionName": "kustoeventhubconnection1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "dataConnectionName": "kustoeventhubconnection1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json index d9abaf9772b0..7d6e7497226e 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsGet.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "dataConnectionName": "DataConnections8" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "dataConnectionName": "DataConnections8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json index 4c7e09b7d2fb..3c9216d3ae98 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsListByDatabase.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8", - "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9", - "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2", - "consumerGroup": "testConsumerGroup2" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8", + "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9", + "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2", + "consumerGroup": "testConsumerGroup2" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json index 1fb8d3788065..88028923b7c6 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDataConnectionsUpdate.json @@ -1,59 +1,59 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "dataConnectionName": "DataConnections8", - "parameters": { - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", - "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", - "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", - "location": "westus", - "kind": "EventHub", - "properties": { - "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", - "consumerGroup": "testConsumerGroup1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json index f4b6adfd87b2..99e27f641cdb 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseAddPrincipals.json @@ -1,69 +1,69 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "databasePrincipalsToAdd": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "databasePrincipalsToAdd": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json index ad1c9c42eb2b..df210225f8e3 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseListPrincipals.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json index 7321c6c47b03..7dc84cfee4ea 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": { - "name": "kustoprincipal1", - "type": "Microsoft.Kusto/clusters/databases/principalAssignments" - }, - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "name": "kustoprincipal1", - "nameAvailable": false, - "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": { + "name": "kustoprincipal1", + "type": "Microsoft.Kusto/clusters/databases/principalAssignments" + }, + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "name": "kustoprincipal1", + "nameAvailable": false, + "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json index 4cf19b4d4be5..9363328f8690 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-09-18", - "parameters": { - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-09-18", + "parameters": { + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json index 5973f67ea030..79be804dcecd 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsDelete.json @@ -1,15 +1,15 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json index 77dfcf895e20..d50e6efbb58f 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsGet.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "principalAssignmentName": "kustoprincipal1", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json index 080811fea6db..93966d2ddca2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasePrincipalAssignmentsList.json @@ -1,45 +1,45 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "Kustodatabase8", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", - "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", - "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", - "properties": { - "role": "Admin", - "principalId": "87654321-1234-1234-1234-123456789123", - "principalType": "App", - "tenantId": "12345678-1234-1234-1234-123456789123", - "tenantName": "tenantName", - "principalName": "TestApp", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json index c8a35a599846..b9e000c296c1 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabaseRemovePrincipals.json @@ -1,69 +1,69 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "databasePrincipalsToRemove": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Some User", - "role": "Admin", - "type": "User", - "fqn": "aaduser=some_guid", - "email": "user@microsoft.com", - "appId": "" - }, - { - "name": "Kusto", - "role": "Viewer", - "type": "Group", - "fqn": "aadgroup=some_guid", - "email": "kusto@microsoft.com", - "appId": "" - }, - { - "name": "SomeApp", - "role": "Admin", - "type": "App", - "fqn": "aadapp=some_guid_app_id", - "email": "", - "appId": "some_guid_app_id" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "databasePrincipalsToRemove": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json index 6184f1f78580..abc1b99faaf2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCheckNameAvailability.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "api-version": "2020-09-18", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "resourceName": { - "name": "kustoresourcename1", - "type": "Microsoft.Kusto/clusters/databases" - } - }, - "responses": { - "200": { - "body": { - "name": "kustoresourcename1", - "nameAvailable": false, - "message": "Name 'kuskus' is already taken. Please specify a different name" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-09-18", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "resourceName": { + "name": "kustoresourcename1", + "type": "Microsoft.Kusto/clusters/databases" + } + }, + "responses": { + "200": { + "body": { + "name": "kustoresourcename1", + "nameAvailable": false, + "message": "Name 'kuskus' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json index e161d5a0a085..a29cb12dda00 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesCreateOrUpdate.json @@ -1,56 +1,56 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "parameters": { - "location": "westus", - "properties": { - "softDeletePeriod": "P1D" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "parameters": { + "location": "westus", + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json index f00f7b7e7313..d8bacb864956 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json index 87cd1481ba25..7cfd373276e5 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesGet.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json index 5c6b1fcf6456..2d35b68dad08 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesListByCluster.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9", - "name": "KustoClusterRPTest4/KustoDatabase9", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json index d9994e7244f7..fb3047fe3043 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoDatabasesUpdate.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-1234-123456789098", - "resourceGroupName": "kustorptest", - "clusterName": "kustoclusterrptest4", - "databaseName": "KustoDatabase8", - "api-version": "2020-09-18", - "parameters": { - "properties": { - "softDeletePeriod": "P1D" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "kind": "ReadWrite", - "location": "westus", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", - "name": "KustoClusterRPTest4/KustoDatabase8", - "type": "Microsoft.Kusto/Clusters/Databases", - "location": "westus", - "kind": "ReadWrite", - "properties": { - "softDeletePeriod": "P1D", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-09-18", + "parameters": { + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json index f5e8a42bd538..ae78796d4f95 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/examples/KustoOperationsList.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "api-version": "2020-09-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "operationName", - "display": { - "provider": "providerName", - "resource": "resourceName", - "operation": "operationName", - "description": "operation description" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2020-09-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "provider": "providerName", + "resource": "resourceName", + "operation": "operationName", + "description": "operation description" + } + } + ] + } + } + } +} diff --git a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json index 7f465fb6d205..37f5606f538c 100644 --- a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json +++ b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json @@ -137,7 +137,8 @@ "Submit a codesign operation.": { "$ref": "./examples/CertificateProfileOperations_Sign.json" } - } + }, + "x-ms-long-running-operation": true } }, "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/{operationId}": { @@ -241,26 +242,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of ExtendedKeyUsage items", - "properties": { - "value": { - "type": "array", - "description": "The ExtendedKeyUsage items on this page", - "items": { - "$ref": "#/definitions/ExtendedKeyUsage" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedExtendedKeyUsage" } }, "default": { @@ -561,6 +543,28 @@ "ekus" ] }, + "PagedExtendedKeyUsage": { + "type": "object", + "description": "Paged collection of ExtendedKeyUsage items", + "properties": { + "value": { + "type": "array", + "description": "The ExtendedKeyUsage items on this page", + "items": { + "$ref": "#/definitions/ExtendedKeyUsage" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "SignatureAlgorithm": { "type": "string", "description": "Algorithms supported for signing.", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json index cc8535b5e200..11e9951bedbe 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-06-01-preview/generated.json @@ -260,7 +260,8 @@ "Starts the generation of a batch of images from a text caption": { "$ref": "./examples/start_generate_image.json" } - } + }, + "x-ms-long-running-operation": true } }, "/operations/images/{operationId}": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json index 2ddf16cdaf9b..b5092f933e68 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-07-01-preview/generated.json @@ -260,7 +260,8 @@ "Starts the generation of a batch of images from a text caption": { "$ref": "./examples/start_generate_image.json" } - } + }, + "x-ms-long-running-operation": true } }, "/operations/images/{operationId}": { diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json index 7da0f7f59584..095e19424bb6 100644 --- a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json @@ -106,26 +106,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of TextBlocklist items", - "properties": { - "value": { - "type": "array", - "description": "The TextBlocklist items on this page", - "items": { - "$ref": "#/definitions/TextBlocklist" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedTextBlocklist" } }, "default": { @@ -437,26 +418,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of TextBlockItem items", - "properties": { - "value": { - "type": "array", - "description": "The TextBlockItem items on this page", - "items": { - "$ref": "#/definitions/TextBlockItem" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedTextBlockItem" } }, "default": { @@ -829,6 +791,50 @@ } } }, + "PagedTextBlockItem": { + "type": "object", + "description": "Paged collection of TextBlockItem items", + "properties": { + "value": { + "type": "array", + "description": "The TextBlockItem items on this page", + "items": { + "$ref": "#/definitions/TextBlockItem" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTextBlocklist": { + "type": "object", + "description": "Paged collection of TextBlocklist items", + "properties": { + "value": { + "type": "array", + "description": "The TextBlocklist items on this page", + "items": { + "$ref": "#/definitions/TextBlocklist" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "RemoveBlockItemsOptions": { "type": "object", "description": "The request of removing blockItems from text blocklist.", diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Base64.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Base64.json index 767c811a9196..2b2cc418be00 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Base64.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Base64.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "prebuilt-layout", - "pages": "1-2,4", - "locale": "en-US", - "stringIndexType": "textElements", - "analyzeRequest": { - "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "prebuilt-layout", + "pages": "1-2,4", + "locale": "en-US", + "stringIndexType": "textElements", + "analyzeRequest": { + "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Url.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Url.json index f229104f6e0a..563084e9fa14 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Url.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AnalyzeDocument_Url.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "customModel", - "pages": "1-2,4", - "locale": "en-US", - "stringIndexType": "textElements", - "analyzeRequest": { - "urlSource": "http://host.com/doc.pdf" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "customModel", + "pages": "1-2,4", + "locale": "en-US", + "stringIndexType": "textElements", + "analyzeRequest": { + "urlSource": "http://host.com/doc.pdf" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AuthorizeCopyDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AuthorizeCopyDocumentModel.json index 55a167b4e421..5390dde580f7 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AuthorizeCopyDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/AuthorizeCopyDocumentModel.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "authorizeCopyRequest": { - "modelId": "targetModel", - "description": "Target model description" - } - }, - "responses": { - "200": { - "body": { - "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", - "targetResourceRegion": "targetResourceRegion", - "targetModelId": "targetModel", - "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", - "accessToken": "accessToken", - "expirationDateTime": "2021-09-23T09:12:54.552Z" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "authorizeCopyRequest": { + "modelId": "targetModel", + "description": "Target model description" + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", + "targetResourceRegion": "targetResourceRegion", + "targetModelId": "targetModel", + "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", + "accessToken": "accessToken", + "expirationDateTime": "2021-09-23T09:12:54.552Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentClassifier.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentClassifier.json index 1ee49fab5741..067008727232 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentClassifier.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentClassifier.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "buildRequest": { - "classifierId": "myClassifier", - "description": "Classifier description", - "docTypes": { - "formA": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formADocs/" - } - }, - "formB": { - "azureBlobFileListSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "fileList": "formB.jsonl" - } - } - } - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "buildRequest": { + "classifierId": "myClassifier", + "description": "Classifier description", + "docTypes": { + "formA": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formADocs/" + } + }, + "formB": { + "azureBlobFileListSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "fileList": "formB.jsonl" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentModel.json index 289b166de83f..52a3c597c329 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/BuildDocumentModel.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "buildRequest": { - "modelId": "myCustomModel", - "description": "Custom model description", - "buildMode": "template", - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "trainingDocs/" - }, - "tags": { - "createdBy": "myUserId" - } - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "buildRequest": { + "modelId": "myCustomModel", + "description": "Custom model description", + "buildMode": "template", + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "trainingDocs/" + }, + "tags": { + "createdBy": "myUserId" + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ClassifyDocument_Url.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ClassifyDocument_Url.json index e03f1ff883e1..e792a67f9b8d 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ClassifyDocument_Url.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ClassifyDocument_Url.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "classifierId": "classifierId", - "stringIndexType": "textElements", - "classifyRequest": { - "urlSource": "http://host.com/doc.pdf" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "classifierId": "classifierId", + "stringIndexType": "textElements", + "classifyRequest": { + "urlSource": "http://host.com/doc.pdf" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ComposeDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ComposeDocumentModel.json index 03d8b4f0bf8d..8341f5f1034b 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ComposeDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/ComposeDocumentModel.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "composeRequest": { - "modelId": "composedModel", - "description": "Composed model description", - "componentModels": [ - { - "modelId": "model1" - }, - { - "modelId": "model2" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "composeRequest": { + "modelId": "composedModel", + "description": "Composed model description", + "componentModels": [ + { + "modelId": "model1" + }, + { + "modelId": "model2" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/CopyDocumentModelTo.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/CopyDocumentModelTo.json index eaa0ccde6bf3..15f9e6c4dad8 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/CopyDocumentModelTo.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/CopyDocumentModelTo.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "sourceModel", - "copyToRequest": { - "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", - "targetResourceRegion": "targetResourceRegion", - "targetModelId": "targetModel", - "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", - "accessToken": "accessToken", - "expirationDateTime": "2021-09-23T09:12:54.552Z" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "sourceModel", + "copyToRequest": { + "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", + "targetResourceRegion": "targetResourceRegion", + "targetModelId": "targetModel", + "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", + "accessToken": "accessToken", + "expirationDateTime": "2021-09-23T09:12:54.552Z" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-02-28-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentClassifier.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentClassifier.json index 2a3a7d2d590a..128345a20baa 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentClassifier.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentClassifier.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "classifierId": "myClassifier" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "classifierId": "myClassifier" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentModel.json index df413840998c..44dfe36432f9 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/DeleteDocumentModel.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "myCustomModel" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "myCustomModel" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetAnalyzeDocumentResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetAnalyzeDocumentResult.json index d2cf9f9aab67..26f213cf392f 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetAnalyzeDocumentResult.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetAnalyzeDocumentResult.json @@ -1,7220 +1,7220 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "prebuilt-invoice", - "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" - }, - "responses": { - "200": { - "body": { - "status": "succeeded", - "createdDateTime": "2021-09-24T13:00:46Z", - "lastUpdatedDateTime": "2021-09-24T13:00:49Z", - "analyzeResult": { - "apiVersion": "2023-02-28-preview", - "modelId": "prebuilt-invoice", - "stringIndexType": "textElements", - "content": "CONTOSO LTD.\nINVOICE\nContoso Headquarters\nINVOICE: INV-100\n123 456th St\nINVOICE DATE: 11/15/2019\nNew York, NY, 10001\nDUE DATE: 12/15/2019\nCUSTOMER NAME: MICROSOFT CORPORATION\nSERVICE PERIOD: 10/14/2019 – 11/14/2019\nCUSTOMER ID: CID-12345\nMicrosoft Corp\n123 Other St,\nRedmond WA, 98052\nBILL TO:\nSHIP TO:\nSERVICE ADDRESS:\nMicrosoft Finance\nMicrosoft Delivery\nMicrosoft Services\n123 Bill St,\n123 Ship St,\n123 Service St,\nRedmond WA, 98052\nRedmond WA, 98052\nRedmond WA, 98052\nSALESPERSON\nP.O. NUMBER\nREQUISITIONER\nSHIPPED VIA\nF.O.B. POINT\nTERMS\nPO-3333\nDATE\nITEM CODE\nDESCRIPTION\nQTY\nUM\nPRICE\nTAX\nAMOUNT\n3/4/2021\nA123\nConsulting Services\n2\nhours\n$30.00\n10%\n$60.00\n3/5/2021\nB456\nDocument Fee\n3\n$10.00\n5%\n$30.00\n3/6/2021\nC789\nPrinting Fee\n10\npages\n$1.00\n20%\n$10.00\nSUBTOTAL\n$100.00\nSALES TAX\n$10.00\nTOTAL\n$110.00\nPREVIOUS UNPAID BALANCE\n$500.00\nAMOUNT DUE\n$610.00\nTHANK YOU FOR YOUR BUSINESS!\nREMIT TO:\nContoso Billing\n123 Remit St\nNew York, NY, 10001\n:unselected:", - "pages": [ - { - "kind": "document", - "pageNumber": 1, - "angle": 0, - "width": 8.5, - "height": 11, - "unit": "inch", - "words": [ - { - "content": "CONTOSO", - "polygon": [ - 0.5911, - 0.6857, - 1.7451, - 0.6857, - 1.7451, - 0.8664, - 0.5911, - 0.8664 - ], - "confidence": 1, - "span": { - "offset": 0, - "length": 7 - } - }, - { - "content": "LTD.", - "polygon": [ - 1.8441, - 0.6879, - 2.3181, - 0.6879, - 2.3181, - 0.865, - 1.8441, - 0.865 - ], - "confidence": 1, - "span": { - "offset": 8, - "length": 4 - } - }, - { - "content": "INVOICE", - "polygon": [ - 7.0751, - 0.589, - 7.9886, - 0.589, - 7.9886, - 0.7697, - 7.0751, - 0.7697 - ], - "confidence": 1, - "span": { - "offset": 13, - "length": 7 - } - }, - { - "content": "Contoso", - "polygon": [ - 0.5882, - 1.4303, - 1.1337, - 1.4303, - 1.1337, - 1.5383, - 0.5882, - 1.5383 - ], - "confidence": 1, - "span": { - "offset": 21, - "length": 7 - } - }, - { - "content": "Headquarters", - "polygon": [ - 1.1905, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 1.1905, - 1.5664 - ], - "confidence": 1, - "span": { - "offset": 29, - "length": 12 - } - }, - { - "content": "INVOICE:", - "polygon": [ - 6.8599, - 1.4217, - 7.4328, - 1.4217, - 7.4328, - 1.5218, - 6.8599, - 1.5218 - ], - "confidence": 1, - "span": { - "offset": 42, - "length": 8 - } - }, - { - "content": "INV-100", - "polygon": [ - 7.4959, - 1.422, - 7.9988, - 1.422, - 7.9988, - 1.5215, - 7.4959, - 1.5215 - ], - "confidence": 1, - "span": { - "offset": 51, - "length": 7 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 1.6339, - 0.8213, - 1.6339, - 0.8213, - 1.742, - 0.5945, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 59, - "length": 3 - } - }, - { - "content": "456th", - "polygon": [ - 0.874, - 1.6092, - 1.2102, - 1.6092, - 1.2102, - 1.742, - 0.874, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 63, - "length": 5 - } - }, - { - "content": "St", - "polygon": [ - 1.2598, - 1.6339, - 1.3812, - 1.6339, - 1.3812, - 1.742, - 1.2598, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 69, - "length": 2 - } - }, - { - "content": "INVOICE", - "polygon": [ - 6.2263, - 1.6254, - 6.7562, - 1.6254, - 6.7562, - 1.7256, - 6.2263, - 1.7256 - ], - "confidence": 1, - "span": { - "offset": 72, - "length": 7 - } - }, - { - "content": "DATE:", - "polygon": [ - 6.8132, - 1.6267, - 7.1891, - 1.6267, - 7.1891, - 1.7248, - 6.8132, - 1.7248 - ], - "confidence": 1, - "span": { - "offset": 80, - "length": 5 - } - }, - { - "content": "11/15/2019", - "polygon": [ - 7.2528, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 7.2528, - 1.7449 - ], - "confidence": 1, - "span": { - "offset": 86, - "length": 10 - } - }, - { - "content": "New", - "polygon": [ - 0.5943, - 1.8385, - 0.8848, - 1.8385, - 0.8848, - 1.9454, - 0.5943, - 1.9454 - ], - "confidence": 1, - "span": { - "offset": 97, - "length": 3 - } - }, - { - "content": "York,", - "polygon": [ - 0.9293, - 1.8307, - 1.2568, - 1.8307, - 1.2568, - 1.9675, - 0.9293, - 1.9675 - ], - "confidence": 1, - "span": { - "offset": 101, - "length": 5 - } - }, - { - "content": "NY,", - "polygon": [ - 1.3205, - 1.8382, - 1.5242, - 1.8382, - 1.5242, - 1.9675, - 1.3205, - 1.9675 - ], - "confidence": 1, - "span": { - "offset": 107, - "length": 3 - } - }, - { - "content": "10001", - "polygon": [ - 1.5915, - 1.8372, - 1.9894, - 1.8372, - 1.9894, - 1.9454, - 1.5915, - 1.9454 - ], - "confidence": 1, - "span": { - "offset": 111, - "length": 5 - } - }, - { - "content": "DUE", - "polygon": [ - 6.4966, - 1.8333, - 6.7569, - 1.8333, - 6.7569, - 1.9322, - 6.4966, - 1.9322 - ], - "confidence": 1, - "span": { - "offset": 117, - "length": 3 - } - }, - { - "content": "DATE:", - "polygon": [ - 6.8126, - 1.8333, - 7.1846, - 1.8333, - 7.1846, - 1.9315, - 6.8126, - 1.9315 - ], - "confidence": 1, - "span": { - "offset": 121, - "length": 5 - } - }, - { - "content": "12/15/2019", - "polygon": [ - 7.2494, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 7.2494, - 1.9515 - ], - "confidence": 1, - "span": { - "offset": 127, - "length": 10 - } - }, - { - "content": "CUSTOMER", - "polygon": [ - 4.9513, - 2.0388, - 5.6868, - 2.0388, - 5.6868, - 2.1389, - 4.9513, - 2.1389 - ], - "confidence": 1, - "span": { - "offset": 138, - "length": 8 - } - }, - { - "content": "NAME:", - "polygon": [ - 5.7412, - 2.04, - 6.1764, - 2.04, - 6.1764, - 2.1381, - 5.7412, - 2.1381 - ], - "confidence": 1, - "span": { - "offset": 147, - "length": 5 - } - }, - { - "content": "MICROSOFT", - "polygon": [ - 6.2419, - 2.0391, - 6.9981, - 2.0391, - 6.9981, - 2.1386, - 6.2419, - 2.1386 - ], - "confidence": 1, - "span": { - "offset": 153, - "length": 9 - } - }, - { - "content": "CORPORATION", - "polygon": [ - 7.0448, - 2.0391, - 7.9825, - 2.0391, - 7.9825, - 2.1386, - 7.0448, - 2.1386 - ], - "confidence": 1, - "span": { - "offset": 163, - "length": 11 - } - }, - { - "content": "SERVICE", - "polygon": [ - 5.1667, - 2.2421, - 5.6923, - 2.2421, - 5.6923, - 2.3422, - 5.1667, - 2.3422 - ], - "confidence": 1, - "span": { - "offset": 175, - "length": 7 - } - }, - { - "content": "PERIOD:", - "polygon": [ - 5.748, - 2.2421, - 6.2721, - 2.2421, - 6.2721, - 2.3422, - 5.748, - 2.3422 - ], - "confidence": 1, - "span": { - "offset": 183, - "length": 7 - } - }, - { - "content": "10/14/2019", - "polygon": [ - 6.3357, - 2.2306, - 7.0749, - 2.2306, - 7.0749, - 2.3615, - 6.3357, - 2.3615 - ], - "confidence": 1, - "span": { - "offset": 191, - "length": 10 - } - }, - { - "content": "–", - "polygon": [ - 7.122, - 2.2922, - 7.1995, - 2.2922, - 7.1995, - 2.3037, - 7.122, - 2.3037 - ], - "confidence": 1, - "span": { - "offset": 202, - "length": 1 - } - }, - { - "content": "11/14/2019", - "polygon": [ - 7.2528, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 7.2528, - 2.3615 - ], - "confidence": 1, - "span": { - "offset": 204, - "length": 10 - } - }, - { - "content": "CUSTOMER", - "polygon": [ - 6.3253, - 2.4488, - 7.0608, - 2.4488, - 7.0608, - 2.5489, - 6.3253, - 2.5489 - ], - "confidence": 1, - "span": { - "offset": 215, - "length": 8 - } - }, - { - "content": "ID:", - "polygon": [ - 7.1153, - 2.45, - 7.2809, - 2.45, - 7.2809, - 2.5481, - 7.1153, - 2.5481 - ], - "confidence": 1, - "span": { - "offset": 224, - "length": 3 - } - }, - { - "content": "CID-12345", - "polygon": [ - 7.3369, - 2.4491, - 7.9951, - 2.4491, - 7.9951, - 2.5486, - 7.3369, - 2.5486 - ], - "confidence": 1, - "span": { - "offset": 228, - "length": 9 - } - }, - { - "content": "Microsoft", - "polygon": [ - 0.5943, - 2.6436, - 1.2303, - 2.6436, - 1.2303, - 2.759, - 0.5943, - 2.759 - ], - "confidence": 1, - "span": { - "offset": 238, - "length": 9 - } - }, - { - "content": "Corp", - "polygon": [ - 1.2808, - 2.651, - 1.586, - 2.651, - 1.586, - 2.7871, - 1.2808, - 2.7871 - ], - "confidence": 1, - "span": { - "offset": 248, - "length": 4 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 2.8541, - 0.8213, - 2.8541, - 0.8213, - 2.9623, - 0.5945, - 2.9623 - ], - "confidence": 1, - "span": { - "offset": 253, - "length": 3 - } - }, - { - "content": "Other", - "polygon": [ - 0.875, - 2.8476, - 1.262, - 2.8476, - 1.262, - 2.9623, - 0.875, - 2.9623 - ], - "confidence": 1, - "span": { - "offset": 257, - "length": 5 - } - }, - { - "content": "St,", - "polygon": [ - 1.3058, - 2.8541, - 1.4633, - 2.8541, - 1.4633, - 2.9845, - 1.3058, - 2.9845 - ], - "confidence": 1, - "span": { - "offset": 263, - "length": 3 - } - }, - { - "content": "Redmond", - "polygon": [ - 0.5943, - 3.0513, - 1.2222, - 3.0513, - 1.2222, - 3.1656, - 0.5943, - 3.1656 - ], - "confidence": 1, - "span": { - "offset": 267, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 1.2753, - 3.0585, - 1.5468, - 3.0585, - 1.5468, - 3.1878, - 1.2753, - 3.1878 - ], - "confidence": 1, - "span": { - "offset": 275, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 1.6033, - 3.0575, - 2.0083, - 3.0575, - 2.0083, - 3.1656, - 1.6033, - 3.1656 - ], - "confidence": 1, - "span": { - "offset": 279, - "length": 5 - } - }, - { - "content": "BILL", - "polygon": [ - 0.5909, - 3.5603, - 0.8438, - 3.5603, - 0.8438, - 3.6579, - 0.5909, - 3.6579 - ], - "confidence": 1, - "span": { - "offset": 285, - "length": 4 - } - }, - { - "content": "TO:", - "polygon": [ - 0.8846, - 3.559, - 1.1032, - 3.559, - 1.1032, - 3.6592, - 0.8846, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 290, - "length": 3 - } - }, - { - "content": "SHIP", - "polygon": [ - 3.3361, - 3.559, - 3.6278, - 3.559, - 3.6278, - 3.6592, - 3.3361, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 294, - "length": 4 - } - }, - { - "content": "TO:", - "polygon": [ - 3.6716, - 3.559, - 3.8903, - 3.559, - 3.8903, - 3.6592, - 3.6716, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 299, - "length": 3 - } - }, - { - "content": "SERVICE", - "polygon": [ - 6.2104, - 3.559, - 6.7361, - 3.559, - 6.7361, - 3.6592, - 6.2104, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 303, - "length": 7 - } - }, - { - "content": "ADDRESS:", - "polygon": [ - 6.7828, - 3.559, - 7.4232, - 3.559, - 7.4232, - 3.6592, - 6.7828, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 311, - "length": 8 - } - }, - { - "content": "Microsoft", - "polygon": [ - 0.5943, - 3.7641, - 1.2303, - 3.7641, - 1.2303, - 3.8794, - 0.5943, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 320, - "length": 9 - } - }, - { - "content": "Finance", - "polygon": [ - 1.287, - 3.7701, - 1.7878, - 3.7701, - 1.7878, - 3.8794, - 1.287, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 330, - "length": 7 - } - }, - { - "content": "Microsoft", - "polygon": [ - 3.3454, - 3.7641, - 3.9814, - 3.7641, - 3.9814, - 3.8794, - 3.3454, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 338, - "length": 9 - } - }, - { - "content": "Delivery", - "polygon": [ - 4.0381, - 3.7647, - 4.5762, - 3.7647, - 4.5762, - 3.9076, - 4.0381, - 3.9076 - ], - "confidence": 1, - "span": { - "offset": 348, - "length": 8 - } - }, - { - "content": "Microsoft", - "polygon": [ - 6.2197, - 3.7641, - 6.8557, - 3.7641, - 6.8557, - 3.8794, - 6.2197, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 357, - "length": 9 - } - }, - { - "content": "Services", - "polygon": [ - 6.9042, - 3.7701, - 7.4427, - 3.7701, - 7.4427, - 3.8794, - 6.9042, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 367, - "length": 8 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 3.9746, - 0.8213, - 3.9746, - 0.8213, - 4.0827, - 0.5945, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 376, - "length": 3 - } - }, - { - "content": "Bill", - "polygon": [ - 0.8842, - 3.9681, - 1.0657, - 3.9681, - 1.0657, - 4.0817, - 0.8842, - 4.0817 - ], - "confidence": 1, - "span": { - "offset": 380, - "length": 4 - } - }, - { - "content": "St,", - "polygon": [ - 1.1222, - 3.9746, - 1.2765, - 3.9746, - 1.2765, - 4.1049, - 1.1222, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 385, - "length": 3 - } - }, - { - "content": "123", - "polygon": [ - 3.3456, - 3.9746, - 3.5724, - 3.9746, - 3.5724, - 4.0827, - 3.3456, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 389, - "length": 3 - } - }, - { - "content": "Ship", - "polygon": [ - 3.6239, - 3.9681, - 3.9042, - 3.9681, - 3.9042, - 4.1109, - 3.6239, - 4.1109 - ], - "confidence": 1, - "span": { - "offset": 393, - "length": 4 - } - }, - { - "content": "St,", - "polygon": [ - 3.9536, - 3.9746, - 4.1111, - 3.9746, - 4.1111, - 4.1049, - 3.9536, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 398, - "length": 3 - } - }, - { - "content": "123", - "polygon": [ - 6.2199, - 3.9746, - 6.4467, - 3.9746, - 6.4467, - 4.0827, - 6.2199, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 402, - "length": 3 - } - }, - { - "content": "Service", - "polygon": [ - 6.4985, - 3.9734, - 6.9738, - 3.9734, - 6.9738, - 4.0827, - 6.4985, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 406, - "length": 7 - } - }, - { - "content": "St,", - "polygon": [ - 7.0246, - 3.9746, - 7.1821, - 3.9746, - 7.1821, - 4.1049, - 7.0246, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 414, - "length": 3 - } - }, - { - "content": "Redmond", - "polygon": [ - 0.5943, - 4.1717, - 1.2222, - 4.1717, - 1.2222, - 4.2861, - 0.5943, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 418, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 1.2753, - 4.1789, - 1.5468, - 4.1789, - 1.5468, - 4.3082, - 1.2753, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 426, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 1.6033, - 4.1779, - 2.0083, - 4.1779, - 2.0083, - 4.2861, - 1.6033, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 430, - "length": 5 - } - }, - { - "content": "Redmond", - "polygon": [ - 3.3454, - 4.1717, - 3.9732, - 4.1717, - 3.9732, - 4.2861, - 3.3454, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 436, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 4.0264, - 4.1789, - 4.2979, - 4.1789, - 4.2979, - 4.3082, - 4.0264, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 444, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 4.3544, - 4.1779, - 4.7594, - 4.1779, - 4.7594, - 4.2861, - 4.3544, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 448, - "length": 5 - } - }, - { - "content": "Redmond", - "polygon": [ - 6.2197, - 4.1717, - 6.8475, - 4.1717, - 6.8475, - 4.2861, - 6.2197, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 454, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 6.9007, - 4.1789, - 7.1722, - 4.1789, - 7.1722, - 4.3082, - 6.9007, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 462, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 7.2287, - 4.1779, - 7.6337, - 4.1779, - 7.6337, - 4.2861, - 7.2287, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 466, - "length": 5 - } - }, - { - "content": "SALESPERSON", - "polygon": [ - 0.7018, - 4.6528, - 1.6092, - 4.6528, - 1.6092, - 4.7529, - 0.7018, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 472, - "length": 11 - } - }, - { - "content": "P.O.", - "polygon": [ - 2.1216, - 4.6528, - 2.3788, - 4.6528, - 2.3788, - 4.7529, - 2.1216, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 484, - "length": 4 - } - }, - { - "content": "NUMBER", - "polygon": [ - 2.4376, - 4.654, - 3.0155, - 4.654, - 3.0155, - 4.7529, - 2.4376, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 489, - "length": 6 - } - }, - { - "content": "REQUISITIONER", - "polygon": [ - 3.4953, - 4.6528, - 4.5157, - 4.6528, - 4.5157, - 4.7687, - 3.4953, - 4.7687 - ], - "confidence": 1, - "span": { - "offset": 496, - "length": 13 - } - }, - { - "content": "SHIPPED", - "polygon": [ - 4.81, - 4.6528, - 5.362, - 4.6528, - 5.362, - 4.7529, - 4.81, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 510, - "length": 7 - } - }, - { - "content": "VIA", - "polygon": [ - 5.409, - 4.654, - 5.6317, - 4.654, - 5.6317, - 4.7517, - 5.409, - 4.7517 - ], - "confidence": 1, - "span": { - "offset": 518, - "length": 3 - } - }, - { - "content": "F.O.B.", - "polygon": [ - 5.8696, - 4.6528, - 6.2467, - 4.6528, - 6.2467, - 4.7529, - 5.8696, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 522, - "length": 6 - } - }, - { - "content": "POINT", - "polygon": [ - 6.3054, - 4.6528, - 6.706, - 4.6528, - 6.706, - 4.7529, - 6.3054, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 529, - "length": 5 - } - }, - { - "content": "TERMS", - "polygon": [ - 7.1806, - 4.6528, - 7.6304, - 4.6528, - 7.6304, - 4.7529, - 7.1806, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 535, - "length": 5 - } - }, - { - "content": "PO-3333", - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ], - "confidence": 1, - "span": { - "offset": 541, - "length": 7 - } - }, - { - "content": "DATE", - "polygon": [ - 0.7409, - 5.421, - 1.0744, - 5.421, - 1.0744, - 5.5186, - 0.7409, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 549, - "length": 4 - } - }, - { - "content": "ITEM", - "polygon": [ - 1.4213, - 5.421, - 1.7338, - 5.421, - 1.7338, - 5.5186, - 1.4213, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 554, - "length": 4 - } - }, - { - "content": "CODE", - "polygon": [ - 1.7893, - 5.4197, - 2.1407, - 5.4197, - 2.1407, - 5.5199, - 1.7893, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 559, - "length": 4 - } - }, - { - "content": "DESCRIPTION", - "polygon": [ - 2.8516, - 5.4197, - 3.7134, - 5.4197, - 3.7134, - 5.5199, - 2.8516, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 564, - "length": 11 - } - }, - { - "content": "QTY", - "polygon": [ - 4.4043, - 5.4197, - 4.6631, - 5.4197, - 4.6631, - 5.5357, - 4.4043, - 5.5357 - ], - "confidence": 1, - "span": { - "offset": 576, - "length": 3 - } - }, - { - "content": "UM", - "polygon": [ - 5.049, - 5.421, - 5.2654, - 5.421, - 5.2654, - 5.5199, - 5.049, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 580, - "length": 2 - } - }, - { - "content": "PRICE", - "polygon": [ - 5.8563, - 5.4199, - 6.2163, - 5.4199, - 6.2163, - 5.5197, - 5.8563, - 5.5197 - ], - "confidence": 1, - "span": { - "offset": 583, - "length": 5 - } - }, - { - "content": "TAX", - "polygon": [ - 6.7169, - 5.421, - 6.974, - 5.421, - 6.974, - 5.5186, - 6.7169, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 589, - "length": 3 - } - }, - { - "content": "AMOUNT", - "polygon": [ - 7.2847, - 5.4197, - 7.9039, - 5.4197, - 7.9039, - 5.5199, - 7.2847, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 593, - "length": 6 - } - }, - { - "content": "3/4/2021", - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ], - "confidence": 1, - "span": { - "offset": 600, - "length": 8 - } - }, - { - "content": "A123", - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 609, - "length": 4 - } - }, - { - "content": "Consulting", - "polygon": [ - 2.3388, - 5.6883, - 3.0438, - 5.6883, - 3.0438, - 5.8312, - 2.3388, - 5.8312 - ], - "confidence": 1, - "span": { - "offset": 614, - "length": 10 - } - }, - { - "content": "Services", - "polygon": [ - 3.0925, - 5.6937, - 3.6278, - 5.6937, - 3.6278, - 5.803, - 3.0925, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 625, - "length": 8 - } - }, - { - "content": "2", - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ], - "confidence": 1, - "span": { - "offset": 634, - "length": 1 - } - }, - { - "content": "hours", - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 636, - "length": 5 - } - }, - { - "content": "$30.00", - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ], - "confidence": 1, - "span": { - "offset": 642, - "length": 6 - } - }, - { - "content": "10%", - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ], - "confidence": 1, - "span": { - "offset": 649, - "length": 3 - } - }, - { - "content": "$60.00", - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ], - "confidence": 1, - "span": { - "offset": 653, - "length": 6 - } - }, - { - "content": "3/5/2021", - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ], - "confidence": 1, - "span": { - "offset": 660, - "length": 8 - } - }, - { - "content": "B456", - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 669, - "length": 4 - } - }, - { - "content": "Document", - "polygon": [ - 2.345, - 5.993, - 3.0318, - 5.993, - 3.0318, - 6.0997, - 2.345, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 674, - "length": 8 - } - }, - { - "content": "Fee", - "polygon": [ - 3.0887, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 3.0887, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 683, - "length": 3 - } - }, - { - "content": "3", - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 687, - "length": 1 - } - }, - { - "content": "$10.00", - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ], - "confidence": 1, - "span": { - "offset": 689, - "length": 6 - } - }, - { - "content": "5%", - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ], - "confidence": 1, - "span": { - "offset": 696, - "length": 2 - } - }, - { - "content": "$30.00", - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ], - "confidence": 1, - "span": { - "offset": 699, - "length": 6 - } - }, - { - "content": "3/6/2021", - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ], - "confidence": 1, - "span": { - "offset": 706, - "length": 8 - } - }, - { - "content": "C789", - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 715, - "length": 4 - } - }, - { - "content": "Printing", - "polygon": [ - 2.345, - 6.2906, - 2.8575, - 6.2906, - 2.8575, - 6.4281, - 2.345, - 6.4281 - ], - "confidence": 1, - "span": { - "offset": 720, - "length": 8 - } - }, - { - "content": "Fee", - "polygon": [ - 2.9143, - 6.2933, - 3.1351, - 6.2933, - 3.1351, - 6.3999, - 2.9143, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 729, - "length": 3 - } - }, - { - "content": "10", - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 733, - "length": 2 - } - }, - { - "content": "pages", - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ], - "confidence": 1, - "span": { - "offset": 736, - "length": 5 - } - }, - { - "content": "$1.00", - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ], - "confidence": 1, - "span": { - "offset": 742, - "length": 5 - } - }, - { - "content": "20%", - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ], - "confidence": 1, - "span": { - "offset": 748, - "length": 3 - } - }, - { - "content": "$10.00", - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ], - "confidence": 1, - "span": { - "offset": 752, - "length": 6 - } - }, - { - "content": "SUBTOTAL", - "polygon": [ - 6.0282, - 6.9118, - 6.7309, - 6.9118, - 6.7309, - 7.0199, - 6.0282, - 7.0199 - ], - "confidence": 1, - "span": { - "offset": 759, - "length": 8 - } - }, - { - "content": "$100.00", - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ], - "confidence": 1, - "span": { - "offset": 768, - "length": 7 - } - }, - { - "content": "SALES", - "polygon": [ - 6.0382, - 7.2089, - 6.4262, - 7.2089, - 6.4262, - 7.317, - 6.0382, - 7.317 - ], - "confidence": 1, - "span": { - "offset": 776, - "length": 5 - } - }, - { - "content": "TAX", - "polygon": [ - 6.4702, - 7.2099, - 6.728, - 7.2099, - 6.728, - 7.316, - 6.4702, - 7.316 - ], - "confidence": 1, - "span": { - "offset": 782, - "length": 3 - } - }, - { - "content": "$10.00", - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ], - "confidence": 1, - "span": { - "offset": 786, - "length": 6 - } - }, - { - "content": "TOTAL", - "polygon": [ - 6.2969, - 7.5089, - 6.7309, - 7.5089, - 6.7309, - 7.617, - 6.2969, - 7.617 - ], - "confidence": 1, - "span": { - "offset": 793, - "length": 5 - } - }, - { - "content": "$110.00", - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ], - "confidence": 1, - "span": { - "offset": 799, - "length": 7 - } - }, - { - "content": "PREVIOUS", - "polygon": [ - 4.8126, - 7.8055, - 5.4789, - 7.8055, - 5.4789, - 7.9137, - 4.8126, - 7.9137 - ], - "confidence": 1, - "span": { - "offset": 807, - "length": 8 - } - }, - { - "content": "UNPAID", - "polygon": [ - 5.5362, - 7.8065, - 6.057, - 7.8065, - 6.057, - 7.9137, - 5.5362, - 7.9137 - ], - "confidence": 1, - "span": { - "offset": 816, - "length": 6 - } - }, - { - "content": "BALANCE", - "polygon": [ - 6.1164, - 7.8057, - 6.7249, - 7.8057, - 6.7249, - 7.9135, - 6.1164, - 7.9135 - ], - "confidence": 1, - "span": { - "offset": 823, - "length": 7 - } - }, - { - "content": "$500.00", - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ], - "confidence": 1, - "span": { - "offset": 831, - "length": 7 - } - }, - { - "content": "AMOUNT", - "polygon": [ - 5.7652, - 8.1022, - 6.4055, - 8.1022, - 6.4055, - 8.2104, - 5.7652, - 8.2104 - ], - "confidence": 1, - "span": { - "offset": 839, - "length": 6 - } - }, - { - "content": "DUE", - "polygon": [ - 6.4562, - 8.1032, - 6.725, - 8.1032, - 6.725, - 8.2104, - 6.4562, - 8.2104 - ], - "confidence": 1, - "span": { - "offset": 846, - "length": 3 - } - }, - { - "content": "$610.00", - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ], - "confidence": 1, - "span": { - "offset": 850, - "length": 7 - } - }, - { - "content": "THANK", - "polygon": [ - 3.129, - 8.5453, - 3.5887, - 8.5453, - 3.5887, - 8.6429, - 3.129, - 8.6429 - ], - "confidence": 1, - "span": { - "offset": 858, - "length": 5 - } - }, - { - "content": "YOU", - "polygon": [ - 3.6316, - 8.544, - 3.9064, - 8.544, - 3.9064, - 8.6442, - 3.6316, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 864, - "length": 3 - } - }, - { - "content": "FOR", - "polygon": [ - 3.9671, - 8.544, - 4.2187, - 8.544, - 4.2187, - 8.6442, - 3.9671, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 868, - "length": 3 - } - }, - { - "content": "YOUR", - "polygon": [ - 4.2638, - 8.544, - 4.6347, - 8.544, - 4.6347, - 8.6442, - 4.2638, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 872, - "length": 4 - } - }, - { - "content": "BUSINESS!", - "polygon": [ - 4.6859, - 8.539, - 5.356, - 8.539, - 5.356, - 8.6442, - 4.6859, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 877, - "length": 9 - } - }, - { - "content": "REMIT", - "polygon": [ - 0.5909, - 9.1619, - 1.0014, - 9.1619, - 1.0014, - 9.2596, - 0.5909, - 9.2596 - ], - "confidence": 1, - "span": { - "offset": 887, - "length": 5 - } - }, - { - "content": "TO:", - "polygon": [ - 1.0446, - 9.1607, - 1.2603, - 9.1607, - 1.2603, - 9.2608, - 1.0446, - 9.2608 - ], - "confidence": 1, - "span": { - "offset": 893, - "length": 3 - } - }, - { - "content": "Contoso", - "polygon": [ - 0.5882, - 9.3697, - 1.1337, - 9.3697, - 1.1337, - 9.4777, - 0.5882, - 9.4777 - ], - "confidence": 1, - "span": { - "offset": 897, - "length": 7 - } - }, - { - "content": "Billing", - "polygon": [ - 1.1905, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 1.1905, - 9.5059 - ], - "confidence": 1, - "span": { - "offset": 905, - "length": 7 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 9.5728, - 0.8213, - 9.5728, - 0.8213, - 9.681, - 0.5945, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 913, - "length": 3 - } - }, - { - "content": "Remit", - "polygon": [ - 0.881, - 9.5717, - 1.264, - 9.5717, - 1.264, - 9.681, - 0.881, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 917, - "length": 5 - } - }, - { - "content": "St", - "polygon": [ - 1.3125, - 9.5728, - 1.4337, - 9.5728, - 1.4337, - 9.681, - 1.3125, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 923, - "length": 2 - } - }, - { - "content": "New", - "polygon": [ - 0.5943, - 9.7808, - 0.8848, - 9.7808, - 0.8848, - 9.8877, - 0.5943, - 9.8877 - ], - "confidence": 1, - "span": { - "offset": 926, - "length": 3 - } - }, - { - "content": "York,", - "polygon": [ - 0.9293, - 9.773, - 1.2568, - 9.773, - 1.2568, - 9.9098, - 0.9293, - 9.9098 - ], - "confidence": 1, - "span": { - "offset": 930, - "length": 5 - } - }, - { - "content": "NY,", - "polygon": [ - 1.3205, - 9.7805, - 1.5233, - 9.7805, - 1.5233, - 9.9098, - 1.3205, - 9.9098 - ], - "confidence": 1, - "span": { - "offset": 936, - "length": 3 - } - }, - { - "content": "10001", - "polygon": [ - 1.5903, - 9.7795, - 1.9882, - 9.7795, - 1.9882, - 9.8877, - 1.5903, - 9.8877 - ], - "confidence": 1, - "span": { - "offset": 940, - "length": 5 - } - } - ], - "selectionMarks": [ - { - "state": "unselected", - "polygon": [ - 4.3231, - 5.6279, - 4.7562, - 5.6279, - 4.7562, - 5.8654, - 4.3231, - 5.8654 - ], - "confidence": 0.212, - "span": { - "offset": 946, - "length": 12 - } - } - ], - "lines": [ - { - "content": "CONTOSO LTD.", - "polygon": [ - 0.5911, - 0.6857, - 2.3181, - 0.6857, - 2.3181, - 0.8664, - 0.5911, - 0.8664 - ], - "spans": [ - { - "offset": 0, - "length": 12 - } - ] - }, - { - "content": "INVOICE", - "polygon": [ - 7.0751, - 0.589, - 7.9886, - 0.589, - 7.9886, - 0.7697, - 7.0751, - 0.7697 - ], - "spans": [ - { - "offset": 13, - "length": 7 - } - ] - }, - { - "content": "Contoso Headquarters", - "polygon": [ - 0.5882, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 0.5882, - 1.5664 - ], - "spans": [ - { - "offset": 21, - "length": 20 - } - ] - }, - { - "content": "INVOICE: INV-100", - "polygon": [ - 6.8599, - 1.4217, - 7.9988, - 1.4217, - 7.9988, - 1.5218, - 6.8599, - 1.5218 - ], - "spans": [ - { - "offset": 42, - "length": 16 - } - ] - }, - { - "content": "123 456th St", - "polygon": [ - 0.5945, - 1.6092, - 1.3812, - 1.6092, - 1.3812, - 1.742, - 0.5945, - 1.742 - ], - "spans": [ - { - "offset": 59, - "length": 12 - } - ] - }, - { - "content": "INVOICE DATE: 11/15/2019", - "polygon": [ - 6.2263, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 6.2263, - 1.7449 - ], - "spans": [ - { - "offset": 72, - "length": 24 - } - ] - }, - { - "content": "New York, NY, 10001", - "polygon": [ - 0.5943, - 1.8307, - 1.9894, - 1.8307, - 1.9894, - 1.9675, - 0.5943, - 1.9675 - ], - "spans": [ - { - "offset": 97, - "length": 19 - } - ] - }, - { - "content": "DUE DATE: 12/15/2019", - "polygon": [ - 6.4966, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 6.4966, - 1.9515 - ], - "spans": [ - { - "offset": 117, - "length": 20 - } - ] - }, - { - "content": "CUSTOMER NAME: MICROSOFT CORPORATION", - "polygon": [ - 4.9513, - 2.0388, - 7.9825, - 2.0388, - 7.9825, - 2.1389, - 4.9513, - 2.1389 - ], - "spans": [ - { - "offset": 138, - "length": 36 - } - ] - }, - { - "content": "SERVICE PERIOD: 10/14/2019 – 11/14/2019", - "polygon": [ - 5.1667, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 5.1667, - 2.3615 - ], - "spans": [ - { - "offset": 175, - "length": 39 - } - ] - }, - { - "content": "CUSTOMER ID: CID-12345", - "polygon": [ - 6.3253, - 2.4488, - 7.9951, - 2.4488, - 7.9951, - 2.5489, - 6.3253, - 2.5489 - ], - "spans": [ - { - "offset": 215, - "length": 22 - } - ] - }, - { - "content": "Microsoft Corp", - "polygon": [ - 0.5943, - 2.6436, - 1.586, - 2.6436, - 1.586, - 2.7871, - 0.5943, - 2.7871 - ], - "spans": [ - { - "offset": 238, - "length": 14 - } - ] - }, - { - "content": "123 Other St,", - "polygon": [ - 0.5945, - 2.8476, - 1.4633, - 2.8476, - 1.4633, - 2.9845, - 0.5945, - 2.9845 - ], - "spans": [ - { - "offset": 253, - "length": 13 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 0.5943, - 3.0513, - 2.0083, - 3.0513, - 2.0083, - 3.1878, - 0.5943, - 3.1878 - ], - "spans": [ - { - "offset": 267, - "length": 17 - } - ] - }, - { - "content": "BILL TO:", - "polygon": [ - 0.5909, - 3.559, - 1.1032, - 3.559, - 1.1032, - 3.6592, - 0.5909, - 3.6592 - ], - "spans": [ - { - "offset": 285, - "length": 8 - } - ] - }, - { - "content": "SHIP TO:", - "polygon": [ - 3.3361, - 3.559, - 3.8903, - 3.559, - 3.8903, - 3.6592, - 3.3361, - 3.6592 - ], - "spans": [ - { - "offset": 294, - "length": 8 - } - ] - }, - { - "content": "SERVICE ADDRESS:", - "polygon": [ - 6.2104, - 3.559, - 7.4232, - 3.559, - 7.4232, - 3.6592, - 6.2104, - 3.6592 - ], - "spans": [ - { - "offset": 303, - "length": 16 - } - ] - }, - { - "content": "Microsoft Finance", - "polygon": [ - 0.5943, - 3.7641, - 1.7878, - 3.7641, - 1.7878, - 3.8794, - 0.5943, - 3.8794 - ], - "spans": [ - { - "offset": 320, - "length": 17 - } - ] - }, - { - "content": "Microsoft Delivery", - "polygon": [ - 3.3454, - 3.7641, - 4.5762, - 3.7641, - 4.5762, - 3.9076, - 3.3454, - 3.9076 - ], - "spans": [ - { - "offset": 338, - "length": 18 - } - ] - }, - { - "content": "Microsoft Services", - "polygon": [ - 6.2197, - 3.7641, - 7.4427, - 3.7641, - 7.4427, - 3.8794, - 6.2197, - 3.8794 - ], - "spans": [ - { - "offset": 357, - "length": 18 - } - ] - }, - { - "content": "123 Bill St,", - "polygon": [ - 0.5945, - 3.9681, - 1.2765, - 3.9681, - 1.2765, - 4.1049, - 0.5945, - 4.1049 - ], - "spans": [ - { - "offset": 376, - "length": 12 - } - ] - }, - { - "content": "123 Ship St,", - "polygon": [ - 3.3456, - 3.9681, - 4.1111, - 3.9681, - 4.1111, - 4.1109, - 3.3456, - 4.1109 - ], - "spans": [ - { - "offset": 389, - "length": 12 - } - ] - }, - { - "content": "123 Service St,", - "polygon": [ - 6.2199, - 3.9734, - 7.1821, - 3.9734, - 7.1821, - 4.1049, - 6.2199, - 4.1049 - ], - "spans": [ - { - "offset": 402, - "length": 15 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 0.5943, - 4.1717, - 2.0083, - 4.1717, - 2.0083, - 4.3082, - 0.5943, - 4.3082 - ], - "spans": [ - { - "offset": 418, - "length": 17 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 3.3454, - 4.1717, - 4.7594, - 4.1717, - 4.7594, - 4.3082, - 3.3454, - 4.3082 - ], - "spans": [ - { - "offset": 436, - "length": 17 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 6.2197, - 4.1717, - 7.6337, - 4.1717, - 7.6337, - 4.3082, - 6.2197, - 4.3082 - ], - "spans": [ - { - "offset": 454, - "length": 17 - } - ] - }, - { - "content": "SALESPERSON", - "polygon": [ - 0.7018, - 4.6528, - 1.6092, - 4.6528, - 1.6092, - 4.7529, - 0.7018, - 4.7529 - ], - "spans": [ - { - "offset": 472, - "length": 11 - } - ] - }, - { - "content": "P.O. NUMBER", - "polygon": [ - 2.1216, - 4.6528, - 3.0155, - 4.6528, - 3.0155, - 4.7529, - 2.1216, - 4.7529 - ], - "spans": [ - { - "offset": 484, - "length": 11 - } - ] - }, - { - "content": "REQUISITIONER", - "polygon": [ - 3.4953, - 4.6528, - 4.5157, - 4.6528, - 4.5157, - 4.7687, - 3.4953, - 4.7687 - ], - "spans": [ - { - "offset": 496, - "length": 13 - } - ] - }, - { - "content": "SHIPPED VIA", - "polygon": [ - 4.81, - 4.6528, - 5.6317, - 4.6528, - 5.6317, - 4.7529, - 4.81, - 4.7529 - ], - "spans": [ - { - "offset": 510, - "length": 11 - } - ] - }, - { - "content": "F.O.B. POINT", - "polygon": [ - 5.8696, - 4.6528, - 6.706, - 4.6528, - 6.706, - 4.7529, - 5.8696, - 4.7529 - ], - "spans": [ - { - "offset": 522, - "length": 12 - } - ] - }, - { - "content": "TERMS", - "polygon": [ - 7.1806, - 4.6528, - 7.6304, - 4.6528, - 7.6304, - 4.7529, - 7.1806, - 4.7529 - ], - "spans": [ - { - "offset": 535, - "length": 5 - } - ] - }, - { - "content": "PO-3333", - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ], - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - { - "content": "DATE", - "polygon": [ - 0.7409, - 5.421, - 1.0744, - 5.421, - 1.0744, - 5.5186, - 0.7409, - 5.5186 - ], - "spans": [ - { - "offset": 549, - "length": 4 - } - ] - }, - { - "content": "ITEM CODE", - "polygon": [ - 1.4213, - 5.4197, - 2.1407, - 5.4197, - 2.1407, - 5.5199, - 1.4213, - 5.5199 - ], - "spans": [ - { - "offset": 554, - "length": 9 - } - ] - }, - { - "content": "DESCRIPTION", - "polygon": [ - 2.8516, - 5.4197, - 3.7134, - 5.4197, - 3.7134, - 5.5199, - 2.8516, - 5.5199 - ], - "spans": [ - { - "offset": 564, - "length": 11 - } - ] - }, - { - "content": "QTY", - "polygon": [ - 4.4043, - 5.4197, - 4.6631, - 5.4197, - 4.6631, - 5.5357, - 4.4043, - 5.5357 - ], - "spans": [ - { - "offset": 576, - "length": 3 - } - ] - }, - { - "content": "UM", - "polygon": [ - 5.049, - 5.421, - 5.2654, - 5.421, - 5.2654, - 5.5199, - 5.049, - 5.5199 - ], - "spans": [ - { - "offset": 580, - "length": 2 - } - ] - }, - { - "content": "PRICE", - "polygon": [ - 5.8563, - 5.4199, - 6.2163, - 5.4199, - 6.2163, - 5.5197, - 5.8563, - 5.5197 - ], - "spans": [ - { - "offset": 583, - "length": 5 - } - ] - }, - { - "content": "TAX", - "polygon": [ - 6.7169, - 5.421, - 6.974, - 5.421, - 6.974, - 5.5186, - 6.7169, - 5.5186 - ], - "spans": [ - { - "offset": 589, - "length": 3 - } - ] - }, - { - "content": "AMOUNT", - "polygon": [ - 7.2847, - 5.4197, - 7.9039, - 5.4197, - 7.9039, - 5.5199, - 7.2847, - 5.5199 - ], - "spans": [ - { - "offset": 593, - "length": 6 - } - ] - }, - { - "content": "3/4/2021", - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ], - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - { - "content": "A123", - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ], - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - { - "content": "Consulting Services", - "polygon": [ - 2.3388, - 5.6883, - 3.6278, - 5.6883, - 3.6278, - 5.8312, - 2.3388, - 5.8312 - ], - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - { - "content": "2", - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ], - "spans": [ - { - "offset": 634, - "length": 1 - } - ] - }, - { - "content": "hours", - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ], - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - { - "content": "$30.00", - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ], - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - }, - { - "content": "10%", - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ], - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - { - "content": "$60.00", - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ], - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - { - "content": "3/5/2021", - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ], - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - { - "content": "B456", - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ], - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - { - "content": "Document Fee", - "polygon": [ - 2.345, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 2.345, - 6.0997 - ], - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - { - "content": "3", - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ], - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ], - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - }, - { - "content": "5%", - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ], - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - { - "content": "$30.00", - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ], - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - { - "content": "3/6/2021", - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ], - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - { - "content": "C789", - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ], - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - { - "content": "Printing Fee", - "polygon": [ - 2.345, - 6.2906, - 3.1351, - 6.2906, - 3.1351, - 6.4281, - 2.345, - 6.4281 - ], - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - { - "content": "10", - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ], - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - { - "content": "pages", - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ], - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - { - "content": "$1.00", - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ], - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - }, - { - "content": "20%", - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ], - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ], - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - }, - { - "content": "SUBTOTAL", - "polygon": [ - 6.0282, - 6.9118, - 6.7309, - 6.9118, - 6.7309, - 7.0199, - 6.0282, - 7.0199 - ], - "spans": [ - { - "offset": 759, - "length": 8 - } - ] - }, - { - "content": "$100.00", - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ], - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - { - "content": "SALES TAX", - "polygon": [ - 6.0382, - 7.2089, - 6.728, - 7.2089, - 6.728, - 7.317, - 6.0382, - 7.317 - ], - "spans": [ - { - "offset": 776, - "length": 9 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ], - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - { - "content": "TOTAL", - "polygon": [ - 6.2969, - 7.5089, - 6.7309, - 7.5089, - 6.7309, - 7.617, - 6.2969, - 7.617 - ], - "spans": [ - { - "offset": 793, - "length": 5 - } - ] - }, - { - "content": "$110.00", - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ], - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - { - "content": "PREVIOUS UNPAID BALANCE", - "polygon": [ - 4.8126, - 7.8055, - 6.7249, - 7.8055, - 6.7249, - 7.9137, - 4.8126, - 7.9137 - ], - "spans": [ - { - "offset": 807, - "length": 23 - } - ] - }, - { - "content": "$500.00", - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ], - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - { - "content": "AMOUNT DUE", - "polygon": [ - 5.7652, - 8.1022, - 6.725, - 8.1022, - 6.725, - 8.2104, - 5.7652, - 8.2104 - ], - "spans": [ - { - "offset": 839, - "length": 10 - } - ] - }, - { - "content": "$610.00", - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ], - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - }, - { - "content": "THANK YOU FOR YOUR BUSINESS!", - "polygon": [ - 3.129, - 8.539, - 5.356, - 8.539, - 5.356, - 8.6442, - 3.129, - 8.6442 - ], - "spans": [ - { - "offset": 858, - "length": 28 - } - ] - }, - { - "content": "REMIT TO:", - "polygon": [ - 0.5909, - 9.1607, - 1.2603, - 9.1607, - 1.2603, - 9.2608, - 0.5909, - 9.2608 - ], - "spans": [ - { - "offset": 887, - "length": 9 - } - ] - }, - { - "content": "Contoso Billing", - "polygon": [ - 0.5882, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 0.5882, - 9.5059 - ], - "spans": [ - { - "offset": 897, - "length": 15 - } - ] - }, - { - "content": "123 Remit St", - "polygon": [ - 0.5945, - 9.5717, - 1.4337, - 9.5717, - 1.4337, - 9.681, - 0.5945, - 9.681 - ], - "spans": [ - { - "offset": 913, - "length": 12 - } - ] - }, - { - "content": "New York, NY, 10001", - "polygon": [ - 0.5943, - 9.773, - 1.9882, - 9.773, - 1.9882, - 9.9098, - 0.5943, - 9.9098 - ], - "spans": [ - { - "offset": 926, - "length": 19 - } - ] - } - ], - "spans": [ - { - "offset": 0, - "length": 958 - } - ] - } - ], - "tables": [ - { - "rowCount": 4, - "columnCount": 8, - "cells": [ - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "DATE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4932, - 5.329, - 1.3011, - 5.3213, - 1.3011, - 5.6056, - 0.5009, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 549, - "length": 4 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "ITEM CODE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.3213, - 2.2476, - 5.3213, - 2.2399, - 5.6056, - 1.3011, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 554, - "length": 9 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "DESCRIPTION", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2476, - 5.3213, - 4.3174, - 5.329, - 4.3097, - 5.6056, - 2.2399, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 564, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "QTY", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3174, - 5.329, - 4.7483, - 5.329, - 4.7483, - 5.6056, - 4.3097, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 576, - "length": 3 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "UM", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.329, - 5.5639, - 5.329, - 5.5639, - 5.6056, - 4.7483, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 580, - "length": 2 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "PRICE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.329, - 6.495, - 5.329, - 6.495, - 5.6056, - 5.5639, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 583, - "length": 5 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "TAX", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.329, - 7.1875, - 5.329, - 7.1952, - 5.6056, - 6.495, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 589, - "length": 3 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "AMOUNT", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1875, - 5.329, - 7.9954, - 5.329, - 7.9954, - 5.598, - 7.1952, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 593, - "length": 6 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/4/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5009, - 5.6056, - 1.3011, - 5.6056, - 1.3011, - 5.8976, - 0.5009, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "A123", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.6056, - 2.2399, - 5.6056, - 2.2322, - 5.8976, - 1.3011, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Consulting Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2399, - 5.6056, - 4.3097, - 5.6056, - 4.3097, - 5.8976, - 2.2322, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "2 :unselected:", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 5.6056, - 4.7483, - 5.6056, - 4.7483, - 5.8976, - 4.3097, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 634, - "length": 1 - }, - { - "offset": 946, - "length": 12 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "hours", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.6056, - 5.5639, - 5.6056, - 5.5639, - 5.8976, - 4.7483, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.6056, - 6.495, - 5.6056, - 6.495, - 5.8976, - 5.5639, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "10%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.6056, - 7.1952, - 5.6056, - 7.1952, - 5.8976, - 6.495, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 5.6056, - 7.9954, - 5.598, - 7.9954, - 5.9053, - 7.1952, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/5/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5009, - 5.8976, - 1.3011, - 5.8976, - 1.3011, - 6.1973, - 0.5086, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "B456", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.8976, - 2.2322, - 5.8976, - 2.2245, - 6.1973, - 1.3011, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Document Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2322, - 5.8976, - 4.3097, - 5.8976, - 4.3097, - 6.1973, - 2.2245, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "3", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 5.8976, - 4.7483, - 5.8976, - 4.7483, - 6.1973, - 4.3097, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.8976, - 5.5639, - 5.8976, - 5.5639, - 6.1973, - 4.7483, - 6.1973 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 2, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.8976, - 6.495, - 5.8976, - 6.495, - 6.1973, - 5.5639, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "5%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.8976, - 7.1952, - 5.8976, - 7.1952, - 6.1973, - 6.495, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 5.8976, - 7.9954, - 5.9053, - 7.9954, - 6.1896, - 7.1952, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/6/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5086, - 6.1973, - 1.3011, - 6.1973, - 1.3011, - 6.4969, - 0.5086, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "C789", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 6.1973, - 2.2245, - 6.1973, - 2.2245, - 6.4969, - 1.3011, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Printing Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2245, - 6.1973, - 4.3097, - 6.1973, - 4.3097, - 6.4969, - 2.2245, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "10", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 6.1973, - 4.7483, - 6.1973, - 4.7483, - 6.4969, - 4.3097, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "pages", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 6.1973, - 5.5639, - 6.1973, - 5.5639, - 6.4969, - 4.7483, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$1.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 6.1973, - 6.495, - 6.1973, - 6.495, - 6.4969, - 5.5639, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "20%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 6.1973, - 7.1952, - 6.1973, - 7.1952, - 6.4969, - 6.495, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 6.1973, - 7.9954, - 6.1896, - 7.9954, - 6.5046, - 7.1952, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4901, - 5.3293, - 7.9946, - 5.3289, - 7.9954, - 6.5019, - 0.4906, - 6.502 - ] - } - ], - "spans": [ - { - "offset": 549, - "length": 209 - }, - { - "offset": 946, - "length": 12 - } - ] - }, - { - "rowCount": 2, - "columnCount": 6, - "cells": [ - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SALESPERSON", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4977, - 4.565, - 1.8042, - 4.565, - 1.8119, - 4.8388, - 0.5054, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 472, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "P.O. NUMBER", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.8042, - 4.565, - 3.3105, - 4.565, - 3.3105, - 4.8388, - 1.8119, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 484, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "REQUISITIONER", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3105, - 4.565, - 4.6939, - 4.565, - 4.6862, - 4.8388, - 3.3105, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 496, - "length": 13 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "SHIPPED VIA", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.6939, - 4.565, - 5.7468, - 4.565, - 5.7468, - 4.8388, - 4.6862, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 510, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "F.O.B. POINT", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.7468, - 4.565, - 6.815, - 4.565, - 6.815, - 4.8388, - 5.7468, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 522, - "length": 12 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "TERMS", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.815, - 4.565, - 7.9985, - 4.565, - 7.9985, - 4.8388, - 6.815, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 535, - "length": 5 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5054, - 4.8388, - 1.8119, - 4.8388, - 1.8119, - 5.1058, - 0.5131, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "PO-3333", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.8119, - 4.8388, - 3.3105, - 4.8388, - 3.3105, - 5.1058, - 1.8119, - 5.1058 - ] - } - ], - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3105, - 4.8388, - 4.6862, - 4.8388, - 4.6862, - 5.1058, - 3.3105, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.6862, - 4.8388, - 5.7468, - 4.8388, - 5.7468, - 5.1058, - 4.6862, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.7468, - 4.8388, - 6.815, - 4.8388, - 6.815, - 5.1058, - 5.7468, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.815, - 4.8388, - 7.9985, - 4.8388, - 7.9985, - 5.1125, - 6.815, - 5.1058 - ] - } - ], - "spans": [] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4971, - 4.565, - 7.9889, - 4.5653, - 7.989, - 5.1146, - 0.4963, - 5.1141 - ] - } - ], - "spans": [ - { - "offset": 472, - "length": 76 - } - ] - }, - { - "rowCount": 5, - "columnCount": 2, - "cells": [ - { - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SUBTOTAL", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7474, - 6.7934, - 6.8058, - 6.7934, - 6.8105, - 7.0886, - 4.7474, - 7.0886 - ] - } - ], - "spans": [ - { - "offset": 759, - "length": 8 - } - ] - }, - { - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$100.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8058, - 6.7934, - 7.9981, - 6.7934, - 7.9981, - 7.0934, - 6.8105, - 7.0886 - ] - } - ], - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SALES TAX", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7474, - 7.0886, - 6.8105, - 7.0886, - 6.8105, - 7.3743, - 4.7427, - 7.3743 - ] - } - ], - "spans": [ - { - "offset": 776, - "length": 9 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.0886, - 7.9981, - 7.0934, - 7.9981, - 7.3934, - 6.8105, - 7.3743 - ] - } - ], - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "TOTAL", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.3743, - 6.8105, - 7.3743, - 6.8105, - 7.6839, - 4.7427, - 7.6839 - ] - } - ], - "spans": [ - { - "offset": 793, - "length": 5 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$110.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.3743, - 7.9981, - 7.3934, - 7.9981, - 7.6886, - 6.8105, - 7.6839 - ] - } - ], - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "PREVIOUS UNPAID BALANCE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.6839, - 6.8105, - 7.6839, - 6.8105, - 7.9743, - 4.7427, - 7.9743 - ] - } - ], - "spans": [ - { - "offset": 807, - "length": 23 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$500.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.6839, - 7.9981, - 7.6886, - 7.9981, - 7.9839, - 6.8105, - 7.9743 - ] - } - ], - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - { - "rowIndex": 4, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "AMOUNT DUE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.9743, - 6.8105, - 7.9743, - 6.8105, - 8.2839, - 4.7381, - 8.2839 - ] - } - ], - "spans": [ - { - "offset": 839, - "length": 10 - } - ] - }, - { - "rowIndex": 4, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$610.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.9743, - 7.9981, - 7.9839, - 7.9981, - 8.2839, - 6.8105, - 8.2839 - ] - } - ], - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7456, - 6.7793, - 8.0143, - 6.7788, - 8.0137, - 8.2981, - 4.7446, - 8.2981 - ] - } - ], - "spans": [ - { - "offset": 759, - "length": 98 - } - ] - } - ], - "documents": [ - { - "docType": "prebuilt:invoice", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "fields": { - "AmountDue": { - "type": "number", - "valueNumber": 610, - "content": "$610.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - }, - "BillingAddress": { - "type": "string", - "valueString": "123 Bill St, Redmond WA, 98052", - "content": "123 Bill St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 3.9681, - 2.0083, - 3.9681, - 2.0083, - 4.3082, - 0.5943, - 4.3082 - ] - } - ], - "confidence": 0.947, - "spans": [ - { - "offset": 376, - "length": 12 - }, - { - "offset": 418, - "length": 17 - } - ] - }, - "BillingAddressRecipient": { - "type": "string", - "valueString": "Microsoft Finance", - "content": "Microsoft Finance", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 3.7641, - 1.7878, - 3.7641, - 1.7878, - 3.8794, - 0.5943, - 3.8794 - ] - } - ], - "confidence": 0.957, - "spans": [ - { - "offset": 320, - "length": 17 - } - ] - }, - "CustomerAddress": { - "type": "string", - "valueString": "123 Other St, Redmond WA, 98052", - "content": "123 Other St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 2.8476, - 2.0083, - 2.8476, - 2.0083, - 3.1878, - 0.5943, - 3.1878 - ] - } - ], - "confidence": 0.947, - "spans": [ - { - "offset": 253, - "length": 31 - } - ] - }, - "CustomerAddressRecipient": { - "type": "string", - "valueString": "Microsoft Corp", - "content": "Microsoft Corp", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 2.6436, - 1.586, - 2.6436, - 1.586, - 2.7871, - 0.5943, - 2.7871 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 238, - "length": 14 - } - ] - }, - "CustomerId": { - "type": "string", - "valueString": "CID-12345", - "content": "CID-12345", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3369, - 2.4491, - 7.9951, - 2.4491, - 7.9951, - 2.5486, - 7.3369, - 2.5486 - ] - } - ], - "confidence": 0.964, - "spans": [ - { - "offset": 228, - "length": 9 - } - ] - }, - "CustomerName": { - "type": "string", - "valueString": "MICROSOFT CORPORATION", - "content": "MICROSOFT CORPORATION", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2419, - 2.0391, - 7.9825, - 2.0391, - 7.9825, - 2.1386, - 6.2419, - 2.1386 - ] - } - ], - "confidence": 0.949, - "spans": [ - { - "offset": 153, - "length": 21 - } - ] - }, - "DueDate": { - "type": "date", - "valueDate": "2019-12-15", - "content": "12/15/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2494, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 7.2494, - 1.9515 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 127, - "length": 10 - } - ] - }, - "InvoiceDate": { - "type": "date", - "valueDate": "2019-11-15", - "content": "11/15/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2528, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 7.2528, - 1.7449 - ] - } - ], - "confidence": 0.972, - "spans": [ - { - "offset": 86, - "length": 10 - } - ] - }, - "InvoiceId": { - "type": "string", - "valueString": "INV-100", - "content": "INV-100", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4959, - 1.422, - 7.9988, - 1.422, - 7.9988, - 1.5215, - 7.4959, - 1.5215 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 51, - "length": 7 - } - ] - }, - "InvoiceTotal": { - "type": "number", - "valueNumber": 110, - "content": "$110.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - "Items": { - "type": "array", - "valueArray": [ - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 60, - "content": "$60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ] - } - ], - "confidence": 0.902, - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-04", - "content": "3/4/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ] - } - ], - "confidence": 0.938, - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Consulting Services", - "content": "Consulting Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.3388, - 5.6883, - 3.6278, - 5.6883, - 3.6278, - 5.8312, - 2.3388, - 5.8312 - ] - } - ], - "confidence": 0.9, - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "A123", - "content": "A123", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ] - } - ], - "confidence": 0.877, - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 2, - "content": "2", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 634, - "length": 1 - } - ] - }, - "Tax": { - "type": "number", - "content": "10%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ] - } - ], - "confidence": 0.78, - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - "Unit": { - "type": "string", - "valueString": "hours", - "content": "hours", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 30, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ] - } - ], - "confidence": 0.828, - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - } - }, - "content": "3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8312, - 0.592, - 5.8312 - ] - } - ], - "confidence": 0.955, - "spans": [ - { - "offset": 600, - "length": 59 - } - ] - }, - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 30, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ] - } - ], - "confidence": 0.916, - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-05", - "content": "3/5/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ] - } - ], - "confidence": 0.902, - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Document Fee", - "content": "Document Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.345, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 2.345, - 6.0997 - ] - } - ], - "confidence": 0.901, - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "B456", - "content": "B456", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ] - } - ], - "confidence": 0.886, - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 3, - "content": "3", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ] - } - ], - "confidence": 0.898, - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - "Tax": { - "type": "number", - "content": "5%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ] - } - ], - "confidence": 0.772, - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ] - } - ], - "confidence": 0.831, - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - } - }, - "content": "3/5/2021 B456 Document Fee 3 $10.00 5% $30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.121, - 0.592, - 6.121 - ] - } - ], - "confidence": 0.941, - "spans": [ - { - "offset": 660, - "length": 45 - } - ] - }, - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ] - } - ], - "confidence": 0.959, - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-06", - "content": "3/6/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ] - } - ], - "confidence": 0.903, - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Printing Fee", - "content": "Printing Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.345, - 6.2906, - 3.1351, - 6.2906, - 3.1351, - 6.4281, - 2.345, - 6.4281 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "C789", - "content": "C789", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ] - } - ], - "confidence": 0.898, - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 10, - "content": "10", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ] - } - ], - "confidence": 0.903, - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - "Tax": { - "type": "number", - "content": "20%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ] - } - ], - "confidence": 0.791, - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - "Unit": { - "type": "string", - "valueString": "pages", - "content": "pages", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 1, - "content": "$1.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ] - } - ], - "confidence": 0.829, - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - } - }, - "content": "3/6/2021 C789 Printing Fee 10 pages $1.00 20% $10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4281, - 0.592, - 6.4281 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 706, - "length": 52 - } - ] - } - ] - }, - "Locale": { - "type": "string", - "valueString": "en-US", - "confidence": 1 - }, - "PreviousUnpaidBalance": { - "type": "number", - "valueNumber": 500, - "content": "$500.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ] - } - ], - "confidence": 0.962, - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - "PurchaseOrder": { - "type": "string", - "valueString": "PO-3333", - "content": "PO-3333", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ] - } - ], - "confidence": 0.967, - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - "RemittanceAddress": { - "type": "string", - "valueString": "123 Remit St New York, NY, 10001", - "content": "123 Remit St New York, NY, 10001", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 9.5717, - 1.9882, - 9.5717, - 1.9882, - 9.9098, - 0.5943, - 9.9098 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 913, - "length": 32 - } - ] - }, - "RemittanceAddressRecipient": { - "type": "string", - "valueString": "Contoso Billing", - "content": "Contoso Billing", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5882, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 0.5882, - 9.5059 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 897, - "length": 15 - } - ] - }, - "ServiceAddress": { - "type": "string", - "valueString": "123 Service St, Redmond WA, 98052", - "content": "123 Service St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2197, - 3.9734, - 7.6337, - 3.9734, - 7.6337, - 4.3082, - 6.2197, - 4.3082 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 402, - "length": 15 - }, - { - "offset": 454, - "length": 17 - } - ] - }, - "ServiceAddressRecipient": { - "type": "string", - "valueString": "Microsoft Services", - "content": "Microsoft Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2197, - 3.7641, - 7.4427, - 3.7641, - 7.4427, - 3.8794, - 6.2197, - 3.8794 - ] - } - ], - "confidence": 0.951, - "spans": [ - { - "offset": 357, - "length": 18 - } - ] - }, - "ServiceEndDate": { - "type": "date", - "valueDate": "2019-11-14", - "content": "11/14/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2528, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 7.2528, - 2.3615 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 204, - "length": 10 - } - ] - }, - "ServiceStartDate": { - "type": "date", - "valueDate": "2019-10-14", - "content": "10/14/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.3357, - 2.2306, - 7.0749, - 2.2306, - 7.0749, - 2.3615, - 6.3357, - 2.3615 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 191, - "length": 10 - } - ] - }, - "ShippingAddress": { - "type": "string", - "valueString": "123 Ship St, Redmond WA, 98052", - "content": "123 Ship St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3454, - 3.9681, - 4.7594, - 3.9681, - 4.7594, - 4.3082, - 3.3454, - 4.3082 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 389, - "length": 12 - }, - { - "offset": 436, - "length": 17 - } - ] - }, - "ShippingAddressRecipient": { - "type": "string", - "valueString": "Microsoft Delivery", - "content": "Microsoft Delivery", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3454, - 3.7641, - 4.5762, - 3.7641, - 4.5762, - 3.9076, - 3.3454, - 3.9076 - ] - } - ], - "confidence": 0.955, - "spans": [ - { - "offset": 338, - "length": 18 - } - ] - }, - "SubTotal": { - "type": "number", - "valueNumber": 100, - "content": "$100.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - "TotalTax": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - "VendorAddress": { - "type": "string", - "valueString": "123 456th St New York, NY, 10001", - "content": "123 456th St New York, NY, 10001", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 1.6092, - 1.9894, - 1.6092, - 1.9894, - 1.9675, - 0.5943, - 1.9675 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 59, - "length": 12 - }, - { - "offset": 97, - "length": 19 - } - ] - }, - "VendorAddressRecipient": { - "type": "string", - "valueString": "Contoso Headquarters", - "content": "Contoso Headquarters", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5882, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 0.5882, - 1.5664 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 21, - "length": 20 - } - ] - }, - "VendorName": { - "type": "string", - "valueString": "CONTOSO LTD.", - "content": "CONTOSO LTD.", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5911, - 0.6857, - 2.3181, - 0.6857, - 2.3181, - 0.8664, - 0.5911, - 0.8664 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 0, - "length": 12 - } - ] - } - }, - "confidence": 1, - "spans": [ - { - "offset": 0, - "length": 958 - } - ] - } - ] - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "prebuilt-invoice", + "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2021-09-24T13:00:46Z", + "lastUpdatedDateTime": "2021-09-24T13:00:49Z", + "analyzeResult": { + "apiVersion": "2023-02-28-preview", + "modelId": "prebuilt-invoice", + "stringIndexType": "textElements", + "content": "CONTOSO LTD.\nINVOICE\nContoso Headquarters\nINVOICE: INV-100\n123 456th St\nINVOICE DATE: 11/15/2019\nNew York, NY, 10001\nDUE DATE: 12/15/2019\nCUSTOMER NAME: MICROSOFT CORPORATION\nSERVICE PERIOD: 10/14/2019 – 11/14/2019\nCUSTOMER ID: CID-12345\nMicrosoft Corp\n123 Other St,\nRedmond WA, 98052\nBILL TO:\nSHIP TO:\nSERVICE ADDRESS:\nMicrosoft Finance\nMicrosoft Delivery\nMicrosoft Services\n123 Bill St,\n123 Ship St,\n123 Service St,\nRedmond WA, 98052\nRedmond WA, 98052\nRedmond WA, 98052\nSALESPERSON\nP.O. NUMBER\nREQUISITIONER\nSHIPPED VIA\nF.O.B. POINT\nTERMS\nPO-3333\nDATE\nITEM CODE\nDESCRIPTION\nQTY\nUM\nPRICE\nTAX\nAMOUNT\n3/4/2021\nA123\nConsulting Services\n2\nhours\n$30.00\n10%\n$60.00\n3/5/2021\nB456\nDocument Fee\n3\n$10.00\n5%\n$30.00\n3/6/2021\nC789\nPrinting Fee\n10\npages\n$1.00\n20%\n$10.00\nSUBTOTAL\n$100.00\nSALES TAX\n$10.00\nTOTAL\n$110.00\nPREVIOUS UNPAID BALANCE\n$500.00\nAMOUNT DUE\n$610.00\nTHANK YOU FOR YOUR BUSINESS!\nREMIT TO:\nContoso Billing\n123 Remit St\nNew York, NY, 10001\n:unselected:", + "pages": [ + { + "kind": "document", + "pageNumber": 1, + "angle": 0, + "width": 8.5, + "height": 11, + "unit": "inch", + "words": [ + { + "content": "CONTOSO", + "polygon": [ + 0.5911, + 0.6857, + 1.7451, + 0.6857, + 1.7451, + 0.8664, + 0.5911, + 0.8664 + ], + "confidence": 1, + "span": { + "offset": 0, + "length": 7 + } + }, + { + "content": "LTD.", + "polygon": [ + 1.8441, + 0.6879, + 2.3181, + 0.6879, + 2.3181, + 0.865, + 1.8441, + 0.865 + ], + "confidence": 1, + "span": { + "offset": 8, + "length": 4 + } + }, + { + "content": "INVOICE", + "polygon": [ + 7.0751, + 0.589, + 7.9886, + 0.589, + 7.9886, + 0.7697, + 7.0751, + 0.7697 + ], + "confidence": 1, + "span": { + "offset": 13, + "length": 7 + } + }, + { + "content": "Contoso", + "polygon": [ + 0.5882, + 1.4303, + 1.1337, + 1.4303, + 1.1337, + 1.5383, + 0.5882, + 1.5383 + ], + "confidence": 1, + "span": { + "offset": 21, + "length": 7 + } + }, + { + "content": "Headquarters", + "polygon": [ + 1.1905, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 1.1905, + 1.5664 + ], + "confidence": 1, + "span": { + "offset": 29, + "length": 12 + } + }, + { + "content": "INVOICE:", + "polygon": [ + 6.8599, + 1.4217, + 7.4328, + 1.4217, + 7.4328, + 1.5218, + 6.8599, + 1.5218 + ], + "confidence": 1, + "span": { + "offset": 42, + "length": 8 + } + }, + { + "content": "INV-100", + "polygon": [ + 7.4959, + 1.422, + 7.9988, + 1.422, + 7.9988, + 1.5215, + 7.4959, + 1.5215 + ], + "confidence": 1, + "span": { + "offset": 51, + "length": 7 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 1.6339, + 0.8213, + 1.6339, + 0.8213, + 1.742, + 0.5945, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 59, + "length": 3 + } + }, + { + "content": "456th", + "polygon": [ + 0.874, + 1.6092, + 1.2102, + 1.6092, + 1.2102, + 1.742, + 0.874, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 63, + "length": 5 + } + }, + { + "content": "St", + "polygon": [ + 1.2598, + 1.6339, + 1.3812, + 1.6339, + 1.3812, + 1.742, + 1.2598, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 69, + "length": 2 + } + }, + { + "content": "INVOICE", + "polygon": [ + 6.2263, + 1.6254, + 6.7562, + 1.6254, + 6.7562, + 1.7256, + 6.2263, + 1.7256 + ], + "confidence": 1, + "span": { + "offset": 72, + "length": 7 + } + }, + { + "content": "DATE:", + "polygon": [ + 6.8132, + 1.6267, + 7.1891, + 1.6267, + 7.1891, + 1.7248, + 6.8132, + 1.7248 + ], + "confidence": 1, + "span": { + "offset": 80, + "length": 5 + } + }, + { + "content": "11/15/2019", + "polygon": [ + 7.2528, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 7.2528, + 1.7449 + ], + "confidence": 1, + "span": { + "offset": 86, + "length": 10 + } + }, + { + "content": "New", + "polygon": [ + 0.5943, + 1.8385, + 0.8848, + 1.8385, + 0.8848, + 1.9454, + 0.5943, + 1.9454 + ], + "confidence": 1, + "span": { + "offset": 97, + "length": 3 + } + }, + { + "content": "York,", + "polygon": [ + 0.9293, + 1.8307, + 1.2568, + 1.8307, + 1.2568, + 1.9675, + 0.9293, + 1.9675 + ], + "confidence": 1, + "span": { + "offset": 101, + "length": 5 + } + }, + { + "content": "NY,", + "polygon": [ + 1.3205, + 1.8382, + 1.5242, + 1.8382, + 1.5242, + 1.9675, + 1.3205, + 1.9675 + ], + "confidence": 1, + "span": { + "offset": 107, + "length": 3 + } + }, + { + "content": "10001", + "polygon": [ + 1.5915, + 1.8372, + 1.9894, + 1.8372, + 1.9894, + 1.9454, + 1.5915, + 1.9454 + ], + "confidence": 1, + "span": { + "offset": 111, + "length": 5 + } + }, + { + "content": "DUE", + "polygon": [ + 6.4966, + 1.8333, + 6.7569, + 1.8333, + 6.7569, + 1.9322, + 6.4966, + 1.9322 + ], + "confidence": 1, + "span": { + "offset": 117, + "length": 3 + } + }, + { + "content": "DATE:", + "polygon": [ + 6.8126, + 1.8333, + 7.1846, + 1.8333, + 7.1846, + 1.9315, + 6.8126, + 1.9315 + ], + "confidence": 1, + "span": { + "offset": 121, + "length": 5 + } + }, + { + "content": "12/15/2019", + "polygon": [ + 7.2494, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 7.2494, + 1.9515 + ], + "confidence": 1, + "span": { + "offset": 127, + "length": 10 + } + }, + { + "content": "CUSTOMER", + "polygon": [ + 4.9513, + 2.0388, + 5.6868, + 2.0388, + 5.6868, + 2.1389, + 4.9513, + 2.1389 + ], + "confidence": 1, + "span": { + "offset": 138, + "length": 8 + } + }, + { + "content": "NAME:", + "polygon": [ + 5.7412, + 2.04, + 6.1764, + 2.04, + 6.1764, + 2.1381, + 5.7412, + 2.1381 + ], + "confidence": 1, + "span": { + "offset": 147, + "length": 5 + } + }, + { + "content": "MICROSOFT", + "polygon": [ + 6.2419, + 2.0391, + 6.9981, + 2.0391, + 6.9981, + 2.1386, + 6.2419, + 2.1386 + ], + "confidence": 1, + "span": { + "offset": 153, + "length": 9 + } + }, + { + "content": "CORPORATION", + "polygon": [ + 7.0448, + 2.0391, + 7.9825, + 2.0391, + 7.9825, + 2.1386, + 7.0448, + 2.1386 + ], + "confidence": 1, + "span": { + "offset": 163, + "length": 11 + } + }, + { + "content": "SERVICE", + "polygon": [ + 5.1667, + 2.2421, + 5.6923, + 2.2421, + 5.6923, + 2.3422, + 5.1667, + 2.3422 + ], + "confidence": 1, + "span": { + "offset": 175, + "length": 7 + } + }, + { + "content": "PERIOD:", + "polygon": [ + 5.748, + 2.2421, + 6.2721, + 2.2421, + 6.2721, + 2.3422, + 5.748, + 2.3422 + ], + "confidence": 1, + "span": { + "offset": 183, + "length": 7 + } + }, + { + "content": "10/14/2019", + "polygon": [ + 6.3357, + 2.2306, + 7.0749, + 2.2306, + 7.0749, + 2.3615, + 6.3357, + 2.3615 + ], + "confidence": 1, + "span": { + "offset": 191, + "length": 10 + } + }, + { + "content": "–", + "polygon": [ + 7.122, + 2.2922, + 7.1995, + 2.2922, + 7.1995, + 2.3037, + 7.122, + 2.3037 + ], + "confidence": 1, + "span": { + "offset": 202, + "length": 1 + } + }, + { + "content": "11/14/2019", + "polygon": [ + 7.2528, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 7.2528, + 2.3615 + ], + "confidence": 1, + "span": { + "offset": 204, + "length": 10 + } + }, + { + "content": "CUSTOMER", + "polygon": [ + 6.3253, + 2.4488, + 7.0608, + 2.4488, + 7.0608, + 2.5489, + 6.3253, + 2.5489 + ], + "confidence": 1, + "span": { + "offset": 215, + "length": 8 + } + }, + { + "content": "ID:", + "polygon": [ + 7.1153, + 2.45, + 7.2809, + 2.45, + 7.2809, + 2.5481, + 7.1153, + 2.5481 + ], + "confidence": 1, + "span": { + "offset": 224, + "length": 3 + } + }, + { + "content": "CID-12345", + "polygon": [ + 7.3369, + 2.4491, + 7.9951, + 2.4491, + 7.9951, + 2.5486, + 7.3369, + 2.5486 + ], + "confidence": 1, + "span": { + "offset": 228, + "length": 9 + } + }, + { + "content": "Microsoft", + "polygon": [ + 0.5943, + 2.6436, + 1.2303, + 2.6436, + 1.2303, + 2.759, + 0.5943, + 2.759 + ], + "confidence": 1, + "span": { + "offset": 238, + "length": 9 + } + }, + { + "content": "Corp", + "polygon": [ + 1.2808, + 2.651, + 1.586, + 2.651, + 1.586, + 2.7871, + 1.2808, + 2.7871 + ], + "confidence": 1, + "span": { + "offset": 248, + "length": 4 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 2.8541, + 0.8213, + 2.8541, + 0.8213, + 2.9623, + 0.5945, + 2.9623 + ], + "confidence": 1, + "span": { + "offset": 253, + "length": 3 + } + }, + { + "content": "Other", + "polygon": [ + 0.875, + 2.8476, + 1.262, + 2.8476, + 1.262, + 2.9623, + 0.875, + 2.9623 + ], + "confidence": 1, + "span": { + "offset": 257, + "length": 5 + } + }, + { + "content": "St,", + "polygon": [ + 1.3058, + 2.8541, + 1.4633, + 2.8541, + 1.4633, + 2.9845, + 1.3058, + 2.9845 + ], + "confidence": 1, + "span": { + "offset": 263, + "length": 3 + } + }, + { + "content": "Redmond", + "polygon": [ + 0.5943, + 3.0513, + 1.2222, + 3.0513, + 1.2222, + 3.1656, + 0.5943, + 3.1656 + ], + "confidence": 1, + "span": { + "offset": 267, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 1.2753, + 3.0585, + 1.5468, + 3.0585, + 1.5468, + 3.1878, + 1.2753, + 3.1878 + ], + "confidence": 1, + "span": { + "offset": 275, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 1.6033, + 3.0575, + 2.0083, + 3.0575, + 2.0083, + 3.1656, + 1.6033, + 3.1656 + ], + "confidence": 1, + "span": { + "offset": 279, + "length": 5 + } + }, + { + "content": "BILL", + "polygon": [ + 0.5909, + 3.5603, + 0.8438, + 3.5603, + 0.8438, + 3.6579, + 0.5909, + 3.6579 + ], + "confidence": 1, + "span": { + "offset": 285, + "length": 4 + } + }, + { + "content": "TO:", + "polygon": [ + 0.8846, + 3.559, + 1.1032, + 3.559, + 1.1032, + 3.6592, + 0.8846, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 290, + "length": 3 + } + }, + { + "content": "SHIP", + "polygon": [ + 3.3361, + 3.559, + 3.6278, + 3.559, + 3.6278, + 3.6592, + 3.3361, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 294, + "length": 4 + } + }, + { + "content": "TO:", + "polygon": [ + 3.6716, + 3.559, + 3.8903, + 3.559, + 3.8903, + 3.6592, + 3.6716, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 299, + "length": 3 + } + }, + { + "content": "SERVICE", + "polygon": [ + 6.2104, + 3.559, + 6.7361, + 3.559, + 6.7361, + 3.6592, + 6.2104, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 303, + "length": 7 + } + }, + { + "content": "ADDRESS:", + "polygon": [ + 6.7828, + 3.559, + 7.4232, + 3.559, + 7.4232, + 3.6592, + 6.7828, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 311, + "length": 8 + } + }, + { + "content": "Microsoft", + "polygon": [ + 0.5943, + 3.7641, + 1.2303, + 3.7641, + 1.2303, + 3.8794, + 0.5943, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 320, + "length": 9 + } + }, + { + "content": "Finance", + "polygon": [ + 1.287, + 3.7701, + 1.7878, + 3.7701, + 1.7878, + 3.8794, + 1.287, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 330, + "length": 7 + } + }, + { + "content": "Microsoft", + "polygon": [ + 3.3454, + 3.7641, + 3.9814, + 3.7641, + 3.9814, + 3.8794, + 3.3454, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 338, + "length": 9 + } + }, + { + "content": "Delivery", + "polygon": [ + 4.0381, + 3.7647, + 4.5762, + 3.7647, + 4.5762, + 3.9076, + 4.0381, + 3.9076 + ], + "confidence": 1, + "span": { + "offset": 348, + "length": 8 + } + }, + { + "content": "Microsoft", + "polygon": [ + 6.2197, + 3.7641, + 6.8557, + 3.7641, + 6.8557, + 3.8794, + 6.2197, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 357, + "length": 9 + } + }, + { + "content": "Services", + "polygon": [ + 6.9042, + 3.7701, + 7.4427, + 3.7701, + 7.4427, + 3.8794, + 6.9042, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 367, + "length": 8 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 3.9746, + 0.8213, + 3.9746, + 0.8213, + 4.0827, + 0.5945, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 376, + "length": 3 + } + }, + { + "content": "Bill", + "polygon": [ + 0.8842, + 3.9681, + 1.0657, + 3.9681, + 1.0657, + 4.0817, + 0.8842, + 4.0817 + ], + "confidence": 1, + "span": { + "offset": 380, + "length": 4 + } + }, + { + "content": "St,", + "polygon": [ + 1.1222, + 3.9746, + 1.2765, + 3.9746, + 1.2765, + 4.1049, + 1.1222, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 385, + "length": 3 + } + }, + { + "content": "123", + "polygon": [ + 3.3456, + 3.9746, + 3.5724, + 3.9746, + 3.5724, + 4.0827, + 3.3456, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 389, + "length": 3 + } + }, + { + "content": "Ship", + "polygon": [ + 3.6239, + 3.9681, + 3.9042, + 3.9681, + 3.9042, + 4.1109, + 3.6239, + 4.1109 + ], + "confidence": 1, + "span": { + "offset": 393, + "length": 4 + } + }, + { + "content": "St,", + "polygon": [ + 3.9536, + 3.9746, + 4.1111, + 3.9746, + 4.1111, + 4.1049, + 3.9536, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 398, + "length": 3 + } + }, + { + "content": "123", + "polygon": [ + 6.2199, + 3.9746, + 6.4467, + 3.9746, + 6.4467, + 4.0827, + 6.2199, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 402, + "length": 3 + } + }, + { + "content": "Service", + "polygon": [ + 6.4985, + 3.9734, + 6.9738, + 3.9734, + 6.9738, + 4.0827, + 6.4985, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 406, + "length": 7 + } + }, + { + "content": "St,", + "polygon": [ + 7.0246, + 3.9746, + 7.1821, + 3.9746, + 7.1821, + 4.1049, + 7.0246, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 414, + "length": 3 + } + }, + { + "content": "Redmond", + "polygon": [ + 0.5943, + 4.1717, + 1.2222, + 4.1717, + 1.2222, + 4.2861, + 0.5943, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 418, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 1.2753, + 4.1789, + 1.5468, + 4.1789, + 1.5468, + 4.3082, + 1.2753, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 426, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 1.6033, + 4.1779, + 2.0083, + 4.1779, + 2.0083, + 4.2861, + 1.6033, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 430, + "length": 5 + } + }, + { + "content": "Redmond", + "polygon": [ + 3.3454, + 4.1717, + 3.9732, + 4.1717, + 3.9732, + 4.2861, + 3.3454, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 436, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 4.0264, + 4.1789, + 4.2979, + 4.1789, + 4.2979, + 4.3082, + 4.0264, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 444, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 4.3544, + 4.1779, + 4.7594, + 4.1779, + 4.7594, + 4.2861, + 4.3544, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 448, + "length": 5 + } + }, + { + "content": "Redmond", + "polygon": [ + 6.2197, + 4.1717, + 6.8475, + 4.1717, + 6.8475, + 4.2861, + 6.2197, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 454, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 6.9007, + 4.1789, + 7.1722, + 4.1789, + 7.1722, + 4.3082, + 6.9007, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 462, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 7.2287, + 4.1779, + 7.6337, + 4.1779, + 7.6337, + 4.2861, + 7.2287, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 466, + "length": 5 + } + }, + { + "content": "SALESPERSON", + "polygon": [ + 0.7018, + 4.6528, + 1.6092, + 4.6528, + 1.6092, + 4.7529, + 0.7018, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 472, + "length": 11 + } + }, + { + "content": "P.O.", + "polygon": [ + 2.1216, + 4.6528, + 2.3788, + 4.6528, + 2.3788, + 4.7529, + 2.1216, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 484, + "length": 4 + } + }, + { + "content": "NUMBER", + "polygon": [ + 2.4376, + 4.654, + 3.0155, + 4.654, + 3.0155, + 4.7529, + 2.4376, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 489, + "length": 6 + } + }, + { + "content": "REQUISITIONER", + "polygon": [ + 3.4953, + 4.6528, + 4.5157, + 4.6528, + 4.5157, + 4.7687, + 3.4953, + 4.7687 + ], + "confidence": 1, + "span": { + "offset": 496, + "length": 13 + } + }, + { + "content": "SHIPPED", + "polygon": [ + 4.81, + 4.6528, + 5.362, + 4.6528, + 5.362, + 4.7529, + 4.81, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 510, + "length": 7 + } + }, + { + "content": "VIA", + "polygon": [ + 5.409, + 4.654, + 5.6317, + 4.654, + 5.6317, + 4.7517, + 5.409, + 4.7517 + ], + "confidence": 1, + "span": { + "offset": 518, + "length": 3 + } + }, + { + "content": "F.O.B.", + "polygon": [ + 5.8696, + 4.6528, + 6.2467, + 4.6528, + 6.2467, + 4.7529, + 5.8696, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 522, + "length": 6 + } + }, + { + "content": "POINT", + "polygon": [ + 6.3054, + 4.6528, + 6.706, + 4.6528, + 6.706, + 4.7529, + 6.3054, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 529, + "length": 5 + } + }, + { + "content": "TERMS", + "polygon": [ + 7.1806, + 4.6528, + 7.6304, + 4.6528, + 7.6304, + 4.7529, + 7.1806, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 535, + "length": 5 + } + }, + { + "content": "PO-3333", + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ], + "confidence": 1, + "span": { + "offset": 541, + "length": 7 + } + }, + { + "content": "DATE", + "polygon": [ + 0.7409, + 5.421, + 1.0744, + 5.421, + 1.0744, + 5.5186, + 0.7409, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 549, + "length": 4 + } + }, + { + "content": "ITEM", + "polygon": [ + 1.4213, + 5.421, + 1.7338, + 5.421, + 1.7338, + 5.5186, + 1.4213, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 554, + "length": 4 + } + }, + { + "content": "CODE", + "polygon": [ + 1.7893, + 5.4197, + 2.1407, + 5.4197, + 2.1407, + 5.5199, + 1.7893, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 559, + "length": 4 + } + }, + { + "content": "DESCRIPTION", + "polygon": [ + 2.8516, + 5.4197, + 3.7134, + 5.4197, + 3.7134, + 5.5199, + 2.8516, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 564, + "length": 11 + } + }, + { + "content": "QTY", + "polygon": [ + 4.4043, + 5.4197, + 4.6631, + 5.4197, + 4.6631, + 5.5357, + 4.4043, + 5.5357 + ], + "confidence": 1, + "span": { + "offset": 576, + "length": 3 + } + }, + { + "content": "UM", + "polygon": [ + 5.049, + 5.421, + 5.2654, + 5.421, + 5.2654, + 5.5199, + 5.049, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 580, + "length": 2 + } + }, + { + "content": "PRICE", + "polygon": [ + 5.8563, + 5.4199, + 6.2163, + 5.4199, + 6.2163, + 5.5197, + 5.8563, + 5.5197 + ], + "confidence": 1, + "span": { + "offset": 583, + "length": 5 + } + }, + { + "content": "TAX", + "polygon": [ + 6.7169, + 5.421, + 6.974, + 5.421, + 6.974, + 5.5186, + 6.7169, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 589, + "length": 3 + } + }, + { + "content": "AMOUNT", + "polygon": [ + 7.2847, + 5.4197, + 7.9039, + 5.4197, + 7.9039, + 5.5199, + 7.2847, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 593, + "length": 6 + } + }, + { + "content": "3/4/2021", + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ], + "confidence": 1, + "span": { + "offset": 600, + "length": 8 + } + }, + { + "content": "A123", + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 609, + "length": 4 + } + }, + { + "content": "Consulting", + "polygon": [ + 2.3388, + 5.6883, + 3.0438, + 5.6883, + 3.0438, + 5.8312, + 2.3388, + 5.8312 + ], + "confidence": 1, + "span": { + "offset": 614, + "length": 10 + } + }, + { + "content": "Services", + "polygon": [ + 3.0925, + 5.6937, + 3.6278, + 5.6937, + 3.6278, + 5.803, + 3.0925, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 625, + "length": 8 + } + }, + { + "content": "2", + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ], + "confidence": 1, + "span": { + "offset": 634, + "length": 1 + } + }, + { + "content": "hours", + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 636, + "length": 5 + } + }, + { + "content": "$30.00", + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ], + "confidence": 1, + "span": { + "offset": 642, + "length": 6 + } + }, + { + "content": "10%", + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ], + "confidence": 1, + "span": { + "offset": 649, + "length": 3 + } + }, + { + "content": "$60.00", + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ], + "confidence": 1, + "span": { + "offset": 653, + "length": 6 + } + }, + { + "content": "3/5/2021", + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ], + "confidence": 1, + "span": { + "offset": 660, + "length": 8 + } + }, + { + "content": "B456", + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 669, + "length": 4 + } + }, + { + "content": "Document", + "polygon": [ + 2.345, + 5.993, + 3.0318, + 5.993, + 3.0318, + 6.0997, + 2.345, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 674, + "length": 8 + } + }, + { + "content": "Fee", + "polygon": [ + 3.0887, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 3.0887, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 683, + "length": 3 + } + }, + { + "content": "3", + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 687, + "length": 1 + } + }, + { + "content": "$10.00", + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ], + "confidence": 1, + "span": { + "offset": 689, + "length": 6 + } + }, + { + "content": "5%", + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ], + "confidence": 1, + "span": { + "offset": 696, + "length": 2 + } + }, + { + "content": "$30.00", + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ], + "confidence": 1, + "span": { + "offset": 699, + "length": 6 + } + }, + { + "content": "3/6/2021", + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ], + "confidence": 1, + "span": { + "offset": 706, + "length": 8 + } + }, + { + "content": "C789", + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 715, + "length": 4 + } + }, + { + "content": "Printing", + "polygon": [ + 2.345, + 6.2906, + 2.8575, + 6.2906, + 2.8575, + 6.4281, + 2.345, + 6.4281 + ], + "confidence": 1, + "span": { + "offset": 720, + "length": 8 + } + }, + { + "content": "Fee", + "polygon": [ + 2.9143, + 6.2933, + 3.1351, + 6.2933, + 3.1351, + 6.3999, + 2.9143, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 729, + "length": 3 + } + }, + { + "content": "10", + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 733, + "length": 2 + } + }, + { + "content": "pages", + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ], + "confidence": 1, + "span": { + "offset": 736, + "length": 5 + } + }, + { + "content": "$1.00", + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ], + "confidence": 1, + "span": { + "offset": 742, + "length": 5 + } + }, + { + "content": "20%", + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ], + "confidence": 1, + "span": { + "offset": 748, + "length": 3 + } + }, + { + "content": "$10.00", + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ], + "confidence": 1, + "span": { + "offset": 752, + "length": 6 + } + }, + { + "content": "SUBTOTAL", + "polygon": [ + 6.0282, + 6.9118, + 6.7309, + 6.9118, + 6.7309, + 7.0199, + 6.0282, + 7.0199 + ], + "confidence": 1, + "span": { + "offset": 759, + "length": 8 + } + }, + { + "content": "$100.00", + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ], + "confidence": 1, + "span": { + "offset": 768, + "length": 7 + } + }, + { + "content": "SALES", + "polygon": [ + 6.0382, + 7.2089, + 6.4262, + 7.2089, + 6.4262, + 7.317, + 6.0382, + 7.317 + ], + "confidence": 1, + "span": { + "offset": 776, + "length": 5 + } + }, + { + "content": "TAX", + "polygon": [ + 6.4702, + 7.2099, + 6.728, + 7.2099, + 6.728, + 7.316, + 6.4702, + 7.316 + ], + "confidence": 1, + "span": { + "offset": 782, + "length": 3 + } + }, + { + "content": "$10.00", + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ], + "confidence": 1, + "span": { + "offset": 786, + "length": 6 + } + }, + { + "content": "TOTAL", + "polygon": [ + 6.2969, + 7.5089, + 6.7309, + 7.5089, + 6.7309, + 7.617, + 6.2969, + 7.617 + ], + "confidence": 1, + "span": { + "offset": 793, + "length": 5 + } + }, + { + "content": "$110.00", + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ], + "confidence": 1, + "span": { + "offset": 799, + "length": 7 + } + }, + { + "content": "PREVIOUS", + "polygon": [ + 4.8126, + 7.8055, + 5.4789, + 7.8055, + 5.4789, + 7.9137, + 4.8126, + 7.9137 + ], + "confidence": 1, + "span": { + "offset": 807, + "length": 8 + } + }, + { + "content": "UNPAID", + "polygon": [ + 5.5362, + 7.8065, + 6.057, + 7.8065, + 6.057, + 7.9137, + 5.5362, + 7.9137 + ], + "confidence": 1, + "span": { + "offset": 816, + "length": 6 + } + }, + { + "content": "BALANCE", + "polygon": [ + 6.1164, + 7.8057, + 6.7249, + 7.8057, + 6.7249, + 7.9135, + 6.1164, + 7.9135 + ], + "confidence": 1, + "span": { + "offset": 823, + "length": 7 + } + }, + { + "content": "$500.00", + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ], + "confidence": 1, + "span": { + "offset": 831, + "length": 7 + } + }, + { + "content": "AMOUNT", + "polygon": [ + 5.7652, + 8.1022, + 6.4055, + 8.1022, + 6.4055, + 8.2104, + 5.7652, + 8.2104 + ], + "confidence": 1, + "span": { + "offset": 839, + "length": 6 + } + }, + { + "content": "DUE", + "polygon": [ + 6.4562, + 8.1032, + 6.725, + 8.1032, + 6.725, + 8.2104, + 6.4562, + 8.2104 + ], + "confidence": 1, + "span": { + "offset": 846, + "length": 3 + } + }, + { + "content": "$610.00", + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ], + "confidence": 1, + "span": { + "offset": 850, + "length": 7 + } + }, + { + "content": "THANK", + "polygon": [ + 3.129, + 8.5453, + 3.5887, + 8.5453, + 3.5887, + 8.6429, + 3.129, + 8.6429 + ], + "confidence": 1, + "span": { + "offset": 858, + "length": 5 + } + }, + { + "content": "YOU", + "polygon": [ + 3.6316, + 8.544, + 3.9064, + 8.544, + 3.9064, + 8.6442, + 3.6316, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 864, + "length": 3 + } + }, + { + "content": "FOR", + "polygon": [ + 3.9671, + 8.544, + 4.2187, + 8.544, + 4.2187, + 8.6442, + 3.9671, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 868, + "length": 3 + } + }, + { + "content": "YOUR", + "polygon": [ + 4.2638, + 8.544, + 4.6347, + 8.544, + 4.6347, + 8.6442, + 4.2638, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 872, + "length": 4 + } + }, + { + "content": "BUSINESS!", + "polygon": [ + 4.6859, + 8.539, + 5.356, + 8.539, + 5.356, + 8.6442, + 4.6859, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 877, + "length": 9 + } + }, + { + "content": "REMIT", + "polygon": [ + 0.5909, + 9.1619, + 1.0014, + 9.1619, + 1.0014, + 9.2596, + 0.5909, + 9.2596 + ], + "confidence": 1, + "span": { + "offset": 887, + "length": 5 + } + }, + { + "content": "TO:", + "polygon": [ + 1.0446, + 9.1607, + 1.2603, + 9.1607, + 1.2603, + 9.2608, + 1.0446, + 9.2608 + ], + "confidence": 1, + "span": { + "offset": 893, + "length": 3 + } + }, + { + "content": "Contoso", + "polygon": [ + 0.5882, + 9.3697, + 1.1337, + 9.3697, + 1.1337, + 9.4777, + 0.5882, + 9.4777 + ], + "confidence": 1, + "span": { + "offset": 897, + "length": 7 + } + }, + { + "content": "Billing", + "polygon": [ + 1.1905, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 1.1905, + 9.5059 + ], + "confidence": 1, + "span": { + "offset": 905, + "length": 7 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 9.5728, + 0.8213, + 9.5728, + 0.8213, + 9.681, + 0.5945, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 913, + "length": 3 + } + }, + { + "content": "Remit", + "polygon": [ + 0.881, + 9.5717, + 1.264, + 9.5717, + 1.264, + 9.681, + 0.881, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 917, + "length": 5 + } + }, + { + "content": "St", + "polygon": [ + 1.3125, + 9.5728, + 1.4337, + 9.5728, + 1.4337, + 9.681, + 1.3125, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 923, + "length": 2 + } + }, + { + "content": "New", + "polygon": [ + 0.5943, + 9.7808, + 0.8848, + 9.7808, + 0.8848, + 9.8877, + 0.5943, + 9.8877 + ], + "confidence": 1, + "span": { + "offset": 926, + "length": 3 + } + }, + { + "content": "York,", + "polygon": [ + 0.9293, + 9.773, + 1.2568, + 9.773, + 1.2568, + 9.9098, + 0.9293, + 9.9098 + ], + "confidence": 1, + "span": { + "offset": 930, + "length": 5 + } + }, + { + "content": "NY,", + "polygon": [ + 1.3205, + 9.7805, + 1.5233, + 9.7805, + 1.5233, + 9.9098, + 1.3205, + 9.9098 + ], + "confidence": 1, + "span": { + "offset": 936, + "length": 3 + } + }, + { + "content": "10001", + "polygon": [ + 1.5903, + 9.7795, + 1.9882, + 9.7795, + 1.9882, + 9.8877, + 1.5903, + 9.8877 + ], + "confidence": 1, + "span": { + "offset": 940, + "length": 5 + } + } + ], + "selectionMarks": [ + { + "state": "unselected", + "polygon": [ + 4.3231, + 5.6279, + 4.7562, + 5.6279, + 4.7562, + 5.8654, + 4.3231, + 5.8654 + ], + "confidence": 0.212, + "span": { + "offset": 946, + "length": 12 + } + } + ], + "lines": [ + { + "content": "CONTOSO LTD.", + "polygon": [ + 0.5911, + 0.6857, + 2.3181, + 0.6857, + 2.3181, + 0.8664, + 0.5911, + 0.8664 + ], + "spans": [ + { + "offset": 0, + "length": 12 + } + ] + }, + { + "content": "INVOICE", + "polygon": [ + 7.0751, + 0.589, + 7.9886, + 0.589, + 7.9886, + 0.7697, + 7.0751, + 0.7697 + ], + "spans": [ + { + "offset": 13, + "length": 7 + } + ] + }, + { + "content": "Contoso Headquarters", + "polygon": [ + 0.5882, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 0.5882, + 1.5664 + ], + "spans": [ + { + "offset": 21, + "length": 20 + } + ] + }, + { + "content": "INVOICE: INV-100", + "polygon": [ + 6.8599, + 1.4217, + 7.9988, + 1.4217, + 7.9988, + 1.5218, + 6.8599, + 1.5218 + ], + "spans": [ + { + "offset": 42, + "length": 16 + } + ] + }, + { + "content": "123 456th St", + "polygon": [ + 0.5945, + 1.6092, + 1.3812, + 1.6092, + 1.3812, + 1.742, + 0.5945, + 1.742 + ], + "spans": [ + { + "offset": 59, + "length": 12 + } + ] + }, + { + "content": "INVOICE DATE: 11/15/2019", + "polygon": [ + 6.2263, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 6.2263, + 1.7449 + ], + "spans": [ + { + "offset": 72, + "length": 24 + } + ] + }, + { + "content": "New York, NY, 10001", + "polygon": [ + 0.5943, + 1.8307, + 1.9894, + 1.8307, + 1.9894, + 1.9675, + 0.5943, + 1.9675 + ], + "spans": [ + { + "offset": 97, + "length": 19 + } + ] + }, + { + "content": "DUE DATE: 12/15/2019", + "polygon": [ + 6.4966, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 6.4966, + 1.9515 + ], + "spans": [ + { + "offset": 117, + "length": 20 + } + ] + }, + { + "content": "CUSTOMER NAME: MICROSOFT CORPORATION", + "polygon": [ + 4.9513, + 2.0388, + 7.9825, + 2.0388, + 7.9825, + 2.1389, + 4.9513, + 2.1389 + ], + "spans": [ + { + "offset": 138, + "length": 36 + } + ] + }, + { + "content": "SERVICE PERIOD: 10/14/2019 – 11/14/2019", + "polygon": [ + 5.1667, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 5.1667, + 2.3615 + ], + "spans": [ + { + "offset": 175, + "length": 39 + } + ] + }, + { + "content": "CUSTOMER ID: CID-12345", + "polygon": [ + 6.3253, + 2.4488, + 7.9951, + 2.4488, + 7.9951, + 2.5489, + 6.3253, + 2.5489 + ], + "spans": [ + { + "offset": 215, + "length": 22 + } + ] + }, + { + "content": "Microsoft Corp", + "polygon": [ + 0.5943, + 2.6436, + 1.586, + 2.6436, + 1.586, + 2.7871, + 0.5943, + 2.7871 + ], + "spans": [ + { + "offset": 238, + "length": 14 + } + ] + }, + { + "content": "123 Other St,", + "polygon": [ + 0.5945, + 2.8476, + 1.4633, + 2.8476, + 1.4633, + 2.9845, + 0.5945, + 2.9845 + ], + "spans": [ + { + "offset": 253, + "length": 13 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 0.5943, + 3.0513, + 2.0083, + 3.0513, + 2.0083, + 3.1878, + 0.5943, + 3.1878 + ], + "spans": [ + { + "offset": 267, + "length": 17 + } + ] + }, + { + "content": "BILL TO:", + "polygon": [ + 0.5909, + 3.559, + 1.1032, + 3.559, + 1.1032, + 3.6592, + 0.5909, + 3.6592 + ], + "spans": [ + { + "offset": 285, + "length": 8 + } + ] + }, + { + "content": "SHIP TO:", + "polygon": [ + 3.3361, + 3.559, + 3.8903, + 3.559, + 3.8903, + 3.6592, + 3.3361, + 3.6592 + ], + "spans": [ + { + "offset": 294, + "length": 8 + } + ] + }, + { + "content": "SERVICE ADDRESS:", + "polygon": [ + 6.2104, + 3.559, + 7.4232, + 3.559, + 7.4232, + 3.6592, + 6.2104, + 3.6592 + ], + "spans": [ + { + "offset": 303, + "length": 16 + } + ] + }, + { + "content": "Microsoft Finance", + "polygon": [ + 0.5943, + 3.7641, + 1.7878, + 3.7641, + 1.7878, + 3.8794, + 0.5943, + 3.8794 + ], + "spans": [ + { + "offset": 320, + "length": 17 + } + ] + }, + { + "content": "Microsoft Delivery", + "polygon": [ + 3.3454, + 3.7641, + 4.5762, + 3.7641, + 4.5762, + 3.9076, + 3.3454, + 3.9076 + ], + "spans": [ + { + "offset": 338, + "length": 18 + } + ] + }, + { + "content": "Microsoft Services", + "polygon": [ + 6.2197, + 3.7641, + 7.4427, + 3.7641, + 7.4427, + 3.8794, + 6.2197, + 3.8794 + ], + "spans": [ + { + "offset": 357, + "length": 18 + } + ] + }, + { + "content": "123 Bill St,", + "polygon": [ + 0.5945, + 3.9681, + 1.2765, + 3.9681, + 1.2765, + 4.1049, + 0.5945, + 4.1049 + ], + "spans": [ + { + "offset": 376, + "length": 12 + } + ] + }, + { + "content": "123 Ship St,", + "polygon": [ + 3.3456, + 3.9681, + 4.1111, + 3.9681, + 4.1111, + 4.1109, + 3.3456, + 4.1109 + ], + "spans": [ + { + "offset": 389, + "length": 12 + } + ] + }, + { + "content": "123 Service St,", + "polygon": [ + 6.2199, + 3.9734, + 7.1821, + 3.9734, + 7.1821, + 4.1049, + 6.2199, + 4.1049 + ], + "spans": [ + { + "offset": 402, + "length": 15 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 0.5943, + 4.1717, + 2.0083, + 4.1717, + 2.0083, + 4.3082, + 0.5943, + 4.3082 + ], + "spans": [ + { + "offset": 418, + "length": 17 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 3.3454, + 4.1717, + 4.7594, + 4.1717, + 4.7594, + 4.3082, + 3.3454, + 4.3082 + ], + "spans": [ + { + "offset": 436, + "length": 17 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 6.2197, + 4.1717, + 7.6337, + 4.1717, + 7.6337, + 4.3082, + 6.2197, + 4.3082 + ], + "spans": [ + { + "offset": 454, + "length": 17 + } + ] + }, + { + "content": "SALESPERSON", + "polygon": [ + 0.7018, + 4.6528, + 1.6092, + 4.6528, + 1.6092, + 4.7529, + 0.7018, + 4.7529 + ], + "spans": [ + { + "offset": 472, + "length": 11 + } + ] + }, + { + "content": "P.O. NUMBER", + "polygon": [ + 2.1216, + 4.6528, + 3.0155, + 4.6528, + 3.0155, + 4.7529, + 2.1216, + 4.7529 + ], + "spans": [ + { + "offset": 484, + "length": 11 + } + ] + }, + { + "content": "REQUISITIONER", + "polygon": [ + 3.4953, + 4.6528, + 4.5157, + 4.6528, + 4.5157, + 4.7687, + 3.4953, + 4.7687 + ], + "spans": [ + { + "offset": 496, + "length": 13 + } + ] + }, + { + "content": "SHIPPED VIA", + "polygon": [ + 4.81, + 4.6528, + 5.6317, + 4.6528, + 5.6317, + 4.7529, + 4.81, + 4.7529 + ], + "spans": [ + { + "offset": 510, + "length": 11 + } + ] + }, + { + "content": "F.O.B. POINT", + "polygon": [ + 5.8696, + 4.6528, + 6.706, + 4.6528, + 6.706, + 4.7529, + 5.8696, + 4.7529 + ], + "spans": [ + { + "offset": 522, + "length": 12 + } + ] + }, + { + "content": "TERMS", + "polygon": [ + 7.1806, + 4.6528, + 7.6304, + 4.6528, + 7.6304, + 4.7529, + 7.1806, + 4.7529 + ], + "spans": [ + { + "offset": 535, + "length": 5 + } + ] + }, + { + "content": "PO-3333", + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ], + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + { + "content": "DATE", + "polygon": [ + 0.7409, + 5.421, + 1.0744, + 5.421, + 1.0744, + 5.5186, + 0.7409, + 5.5186 + ], + "spans": [ + { + "offset": 549, + "length": 4 + } + ] + }, + { + "content": "ITEM CODE", + "polygon": [ + 1.4213, + 5.4197, + 2.1407, + 5.4197, + 2.1407, + 5.5199, + 1.4213, + 5.5199 + ], + "spans": [ + { + "offset": 554, + "length": 9 + } + ] + }, + { + "content": "DESCRIPTION", + "polygon": [ + 2.8516, + 5.4197, + 3.7134, + 5.4197, + 3.7134, + 5.5199, + 2.8516, + 5.5199 + ], + "spans": [ + { + "offset": 564, + "length": 11 + } + ] + }, + { + "content": "QTY", + "polygon": [ + 4.4043, + 5.4197, + 4.6631, + 5.4197, + 4.6631, + 5.5357, + 4.4043, + 5.5357 + ], + "spans": [ + { + "offset": 576, + "length": 3 + } + ] + }, + { + "content": "UM", + "polygon": [ + 5.049, + 5.421, + 5.2654, + 5.421, + 5.2654, + 5.5199, + 5.049, + 5.5199 + ], + "spans": [ + { + "offset": 580, + "length": 2 + } + ] + }, + { + "content": "PRICE", + "polygon": [ + 5.8563, + 5.4199, + 6.2163, + 5.4199, + 6.2163, + 5.5197, + 5.8563, + 5.5197 + ], + "spans": [ + { + "offset": 583, + "length": 5 + } + ] + }, + { + "content": "TAX", + "polygon": [ + 6.7169, + 5.421, + 6.974, + 5.421, + 6.974, + 5.5186, + 6.7169, + 5.5186 + ], + "spans": [ + { + "offset": 589, + "length": 3 + } + ] + }, + { + "content": "AMOUNT", + "polygon": [ + 7.2847, + 5.4197, + 7.9039, + 5.4197, + 7.9039, + 5.5199, + 7.2847, + 5.5199 + ], + "spans": [ + { + "offset": 593, + "length": 6 + } + ] + }, + { + "content": "3/4/2021", + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ], + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + { + "content": "A123", + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ], + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + { + "content": "Consulting Services", + "polygon": [ + 2.3388, + 5.6883, + 3.6278, + 5.6883, + 3.6278, + 5.8312, + 2.3388, + 5.8312 + ], + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + { + "content": "2", + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ], + "spans": [ + { + "offset": 634, + "length": 1 + } + ] + }, + { + "content": "hours", + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ], + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + { + "content": "$30.00", + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ], + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + }, + { + "content": "10%", + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ], + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + { + "content": "$60.00", + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ], + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + { + "content": "3/5/2021", + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ], + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + { + "content": "B456", + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ], + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + { + "content": "Document Fee", + "polygon": [ + 2.345, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 2.345, + 6.0997 + ], + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + { + "content": "3", + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ], + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ], + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + }, + { + "content": "5%", + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ], + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + { + "content": "$30.00", + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ], + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + { + "content": "3/6/2021", + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ], + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + { + "content": "C789", + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ], + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + { + "content": "Printing Fee", + "polygon": [ + 2.345, + 6.2906, + 3.1351, + 6.2906, + 3.1351, + 6.4281, + 2.345, + 6.4281 + ], + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + { + "content": "10", + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ], + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + { + "content": "pages", + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ], + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + { + "content": "$1.00", + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ], + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + }, + { + "content": "20%", + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ], + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ], + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + }, + { + "content": "SUBTOTAL", + "polygon": [ + 6.0282, + 6.9118, + 6.7309, + 6.9118, + 6.7309, + 7.0199, + 6.0282, + 7.0199 + ], + "spans": [ + { + "offset": 759, + "length": 8 + } + ] + }, + { + "content": "$100.00", + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ], + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + { + "content": "SALES TAX", + "polygon": [ + 6.0382, + 7.2089, + 6.728, + 7.2089, + 6.728, + 7.317, + 6.0382, + 7.317 + ], + "spans": [ + { + "offset": 776, + "length": 9 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ], + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + { + "content": "TOTAL", + "polygon": [ + 6.2969, + 7.5089, + 6.7309, + 7.5089, + 6.7309, + 7.617, + 6.2969, + 7.617 + ], + "spans": [ + { + "offset": 793, + "length": 5 + } + ] + }, + { + "content": "$110.00", + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ], + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + { + "content": "PREVIOUS UNPAID BALANCE", + "polygon": [ + 4.8126, + 7.8055, + 6.7249, + 7.8055, + 6.7249, + 7.9137, + 4.8126, + 7.9137 + ], + "spans": [ + { + "offset": 807, + "length": 23 + } + ] + }, + { + "content": "$500.00", + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ], + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + { + "content": "AMOUNT DUE", + "polygon": [ + 5.7652, + 8.1022, + 6.725, + 8.1022, + 6.725, + 8.2104, + 5.7652, + 8.2104 + ], + "spans": [ + { + "offset": 839, + "length": 10 + } + ] + }, + { + "content": "$610.00", + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ], + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + }, + { + "content": "THANK YOU FOR YOUR BUSINESS!", + "polygon": [ + 3.129, + 8.539, + 5.356, + 8.539, + 5.356, + 8.6442, + 3.129, + 8.6442 + ], + "spans": [ + { + "offset": 858, + "length": 28 + } + ] + }, + { + "content": "REMIT TO:", + "polygon": [ + 0.5909, + 9.1607, + 1.2603, + 9.1607, + 1.2603, + 9.2608, + 0.5909, + 9.2608 + ], + "spans": [ + { + "offset": 887, + "length": 9 + } + ] + }, + { + "content": "Contoso Billing", + "polygon": [ + 0.5882, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 0.5882, + 9.5059 + ], + "spans": [ + { + "offset": 897, + "length": 15 + } + ] + }, + { + "content": "123 Remit St", + "polygon": [ + 0.5945, + 9.5717, + 1.4337, + 9.5717, + 1.4337, + 9.681, + 0.5945, + 9.681 + ], + "spans": [ + { + "offset": 913, + "length": 12 + } + ] + }, + { + "content": "New York, NY, 10001", + "polygon": [ + 0.5943, + 9.773, + 1.9882, + 9.773, + 1.9882, + 9.9098, + 0.5943, + 9.9098 + ], + "spans": [ + { + "offset": 926, + "length": 19 + } + ] + } + ], + "spans": [ + { + "offset": 0, + "length": 958 + } + ] + } + ], + "tables": [ + { + "rowCount": 4, + "columnCount": 8, + "cells": [ + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "DATE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4932, + 5.329, + 1.3011, + 5.3213, + 1.3011, + 5.6056, + 0.5009, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 549, + "length": 4 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "ITEM CODE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.3213, + 2.2476, + 5.3213, + 2.2399, + 5.6056, + 1.3011, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 554, + "length": 9 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "DESCRIPTION", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2476, + 5.3213, + 4.3174, + 5.329, + 4.3097, + 5.6056, + 2.2399, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 564, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "QTY", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3174, + 5.329, + 4.7483, + 5.329, + 4.7483, + 5.6056, + 4.3097, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 576, + "length": 3 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "UM", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.329, + 5.5639, + 5.329, + 5.5639, + 5.6056, + 4.7483, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 580, + "length": 2 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "PRICE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.329, + 6.495, + 5.329, + 6.495, + 5.6056, + 5.5639, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 583, + "length": 5 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "TAX", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.329, + 7.1875, + 5.329, + 7.1952, + 5.6056, + 6.495, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 589, + "length": 3 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "AMOUNT", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1875, + 5.329, + 7.9954, + 5.329, + 7.9954, + 5.598, + 7.1952, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 593, + "length": 6 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/4/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5009, + 5.6056, + 1.3011, + 5.6056, + 1.3011, + 5.8976, + 0.5009, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "A123", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.6056, + 2.2399, + 5.6056, + 2.2322, + 5.8976, + 1.3011, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Consulting Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2399, + 5.6056, + 4.3097, + 5.6056, + 4.3097, + 5.8976, + 2.2322, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "2 :unselected:", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 5.6056, + 4.7483, + 5.6056, + 4.7483, + 5.8976, + 4.3097, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 634, + "length": 1 + }, + { + "offset": 946, + "length": 12 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "hours", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.6056, + 5.5639, + 5.6056, + 5.5639, + 5.8976, + 4.7483, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.6056, + 6.495, + 5.6056, + 6.495, + 5.8976, + 5.5639, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "10%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.6056, + 7.1952, + 5.6056, + 7.1952, + 5.8976, + 6.495, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 5.6056, + 7.9954, + 5.598, + 7.9954, + 5.9053, + 7.1952, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/5/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5009, + 5.8976, + 1.3011, + 5.8976, + 1.3011, + 6.1973, + 0.5086, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "B456", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.8976, + 2.2322, + 5.8976, + 2.2245, + 6.1973, + 1.3011, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Document Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2322, + 5.8976, + 4.3097, + 5.8976, + 4.3097, + 6.1973, + 2.2245, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "3", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 5.8976, + 4.7483, + 5.8976, + 4.7483, + 6.1973, + 4.3097, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.8976, + 5.5639, + 5.8976, + 5.5639, + 6.1973, + 4.7483, + 6.1973 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 2, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.8976, + 6.495, + 5.8976, + 6.495, + 6.1973, + 5.5639, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "5%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.8976, + 7.1952, + 5.8976, + 7.1952, + 6.1973, + 6.495, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 5.8976, + 7.9954, + 5.9053, + 7.9954, + 6.1896, + 7.1952, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/6/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5086, + 6.1973, + 1.3011, + 6.1973, + 1.3011, + 6.4969, + 0.5086, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "C789", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 6.1973, + 2.2245, + 6.1973, + 2.2245, + 6.4969, + 1.3011, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Printing Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2245, + 6.1973, + 4.3097, + 6.1973, + 4.3097, + 6.4969, + 2.2245, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "10", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 6.1973, + 4.7483, + 6.1973, + 4.7483, + 6.4969, + 4.3097, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "pages", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 6.1973, + 5.5639, + 6.1973, + 5.5639, + 6.4969, + 4.7483, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$1.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 6.1973, + 6.495, + 6.1973, + 6.495, + 6.4969, + 5.5639, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "20%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 6.1973, + 7.1952, + 6.1973, + 7.1952, + 6.4969, + 6.495, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 6.1973, + 7.9954, + 6.1896, + 7.9954, + 6.5046, + 7.1952, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4901, + 5.3293, + 7.9946, + 5.3289, + 7.9954, + 6.5019, + 0.4906, + 6.502 + ] + } + ], + "spans": [ + { + "offset": 549, + "length": 209 + }, + { + "offset": 946, + "length": 12 + } + ] + }, + { + "rowCount": 2, + "columnCount": 6, + "cells": [ + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SALESPERSON", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4977, + 4.565, + 1.8042, + 4.565, + 1.8119, + 4.8388, + 0.5054, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 472, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "P.O. NUMBER", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.8042, + 4.565, + 3.3105, + 4.565, + 3.3105, + 4.8388, + 1.8119, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 484, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "REQUISITIONER", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3105, + 4.565, + 4.6939, + 4.565, + 4.6862, + 4.8388, + 3.3105, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 496, + "length": 13 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "SHIPPED VIA", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.6939, + 4.565, + 5.7468, + 4.565, + 5.7468, + 4.8388, + 4.6862, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 510, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "F.O.B. POINT", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.7468, + 4.565, + 6.815, + 4.565, + 6.815, + 4.8388, + 5.7468, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 522, + "length": 12 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "TERMS", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.815, + 4.565, + 7.9985, + 4.565, + 7.9985, + 4.8388, + 6.815, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 535, + "length": 5 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5054, + 4.8388, + 1.8119, + 4.8388, + 1.8119, + 5.1058, + 0.5131, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "PO-3333", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.8119, + 4.8388, + 3.3105, + 4.8388, + 3.3105, + 5.1058, + 1.8119, + 5.1058 + ] + } + ], + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3105, + 4.8388, + 4.6862, + 4.8388, + 4.6862, + 5.1058, + 3.3105, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.6862, + 4.8388, + 5.7468, + 4.8388, + 5.7468, + 5.1058, + 4.6862, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.7468, + 4.8388, + 6.815, + 4.8388, + 6.815, + 5.1058, + 5.7468, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.815, + 4.8388, + 7.9985, + 4.8388, + 7.9985, + 5.1125, + 6.815, + 5.1058 + ] + } + ], + "spans": [] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4971, + 4.565, + 7.9889, + 4.5653, + 7.989, + 5.1146, + 0.4963, + 5.1141 + ] + } + ], + "spans": [ + { + "offset": 472, + "length": 76 + } + ] + }, + { + "rowCount": 5, + "columnCount": 2, + "cells": [ + { + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SUBTOTAL", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7474, + 6.7934, + 6.8058, + 6.7934, + 6.8105, + 7.0886, + 4.7474, + 7.0886 + ] + } + ], + "spans": [ + { + "offset": 759, + "length": 8 + } + ] + }, + { + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$100.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8058, + 6.7934, + 7.9981, + 6.7934, + 7.9981, + 7.0934, + 6.8105, + 7.0886 + ] + } + ], + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SALES TAX", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7474, + 7.0886, + 6.8105, + 7.0886, + 6.8105, + 7.3743, + 4.7427, + 7.3743 + ] + } + ], + "spans": [ + { + "offset": 776, + "length": 9 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.0886, + 7.9981, + 7.0934, + 7.9981, + 7.3934, + 6.8105, + 7.3743 + ] + } + ], + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "TOTAL", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.3743, + 6.8105, + 7.3743, + 6.8105, + 7.6839, + 4.7427, + 7.6839 + ] + } + ], + "spans": [ + { + "offset": 793, + "length": 5 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$110.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.3743, + 7.9981, + 7.3934, + 7.9981, + 7.6886, + 6.8105, + 7.6839 + ] + } + ], + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "PREVIOUS UNPAID BALANCE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.6839, + 6.8105, + 7.6839, + 6.8105, + 7.9743, + 4.7427, + 7.9743 + ] + } + ], + "spans": [ + { + "offset": 807, + "length": 23 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$500.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.6839, + 7.9981, + 7.6886, + 7.9981, + 7.9839, + 6.8105, + 7.9743 + ] + } + ], + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + { + "rowIndex": 4, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "AMOUNT DUE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.9743, + 6.8105, + 7.9743, + 6.8105, + 8.2839, + 4.7381, + 8.2839 + ] + } + ], + "spans": [ + { + "offset": 839, + "length": 10 + } + ] + }, + { + "rowIndex": 4, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$610.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.9743, + 7.9981, + 7.9839, + 7.9981, + 8.2839, + 6.8105, + 8.2839 + ] + } + ], + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7456, + 6.7793, + 8.0143, + 6.7788, + 8.0137, + 8.2981, + 4.7446, + 8.2981 + ] + } + ], + "spans": [ + { + "offset": 759, + "length": 98 + } + ] + } + ], + "documents": [ + { + "docType": "prebuilt:invoice", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "fields": { + "AmountDue": { + "type": "number", + "valueNumber": 610, + "content": "$610.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + }, + "BillingAddress": { + "type": "string", + "valueString": "123 Bill St, Redmond WA, 98052", + "content": "123 Bill St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 3.9681, + 2.0083, + 3.9681, + 2.0083, + 4.3082, + 0.5943, + 4.3082 + ] + } + ], + "confidence": 0.947, + "spans": [ + { + "offset": 376, + "length": 12 + }, + { + "offset": 418, + "length": 17 + } + ] + }, + "BillingAddressRecipient": { + "type": "string", + "valueString": "Microsoft Finance", + "content": "Microsoft Finance", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 3.7641, + 1.7878, + 3.7641, + 1.7878, + 3.8794, + 0.5943, + 3.8794 + ] + } + ], + "confidence": 0.957, + "spans": [ + { + "offset": 320, + "length": 17 + } + ] + }, + "CustomerAddress": { + "type": "string", + "valueString": "123 Other St, Redmond WA, 98052", + "content": "123 Other St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 2.8476, + 2.0083, + 2.8476, + 2.0083, + 3.1878, + 0.5943, + 3.1878 + ] + } + ], + "confidence": 0.947, + "spans": [ + { + "offset": 253, + "length": 31 + } + ] + }, + "CustomerAddressRecipient": { + "type": "string", + "valueString": "Microsoft Corp", + "content": "Microsoft Corp", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 2.6436, + 1.586, + 2.6436, + 1.586, + 2.7871, + 0.5943, + 2.7871 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 238, + "length": 14 + } + ] + }, + "CustomerId": { + "type": "string", + "valueString": "CID-12345", + "content": "CID-12345", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3369, + 2.4491, + 7.9951, + 2.4491, + 7.9951, + 2.5486, + 7.3369, + 2.5486 + ] + } + ], + "confidence": 0.964, + "spans": [ + { + "offset": 228, + "length": 9 + } + ] + }, + "CustomerName": { + "type": "string", + "valueString": "MICROSOFT CORPORATION", + "content": "MICROSOFT CORPORATION", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2419, + 2.0391, + 7.9825, + 2.0391, + 7.9825, + 2.1386, + 6.2419, + 2.1386 + ] + } + ], + "confidence": 0.949, + "spans": [ + { + "offset": 153, + "length": 21 + } + ] + }, + "DueDate": { + "type": "date", + "valueDate": "2019-12-15", + "content": "12/15/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2494, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 7.2494, + 1.9515 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 127, + "length": 10 + } + ] + }, + "InvoiceDate": { + "type": "date", + "valueDate": "2019-11-15", + "content": "11/15/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2528, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 7.2528, + 1.7449 + ] + } + ], + "confidence": 0.972, + "spans": [ + { + "offset": 86, + "length": 10 + } + ] + }, + "InvoiceId": { + "type": "string", + "valueString": "INV-100", + "content": "INV-100", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4959, + 1.422, + 7.9988, + 1.422, + 7.9988, + 1.5215, + 7.4959, + 1.5215 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 51, + "length": 7 + } + ] + }, + "InvoiceTotal": { + "type": "number", + "valueNumber": 110, + "content": "$110.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + "Items": { + "type": "array", + "valueArray": [ + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 60, + "content": "$60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ] + } + ], + "confidence": 0.902, + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-04", + "content": "3/4/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ] + } + ], + "confidence": 0.938, + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Consulting Services", + "content": "Consulting Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.3388, + 5.6883, + 3.6278, + 5.6883, + 3.6278, + 5.8312, + 2.3388, + 5.8312 + ] + } + ], + "confidence": 0.9, + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "A123", + "content": "A123", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ] + } + ], + "confidence": 0.877, + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 2, + "content": "2", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 634, + "length": 1 + } + ] + }, + "Tax": { + "type": "number", + "content": "10%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ] + } + ], + "confidence": 0.78, + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + "Unit": { + "type": "string", + "valueString": "hours", + "content": "hours", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 30, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ] + } + ], + "confidence": 0.828, + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + } + }, + "content": "3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8312, + 0.592, + 5.8312 + ] + } + ], + "confidence": 0.955, + "spans": [ + { + "offset": 600, + "length": 59 + } + ] + }, + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 30, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ] + } + ], + "confidence": 0.916, + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-05", + "content": "3/5/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ] + } + ], + "confidence": 0.902, + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Document Fee", + "content": "Document Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.345, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 2.345, + 6.0997 + ] + } + ], + "confidence": 0.901, + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "B456", + "content": "B456", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ] + } + ], + "confidence": 0.886, + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 3, + "content": "3", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ] + } + ], + "confidence": 0.898, + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + "Tax": { + "type": "number", + "content": "5%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ] + } + ], + "confidence": 0.772, + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ] + } + ], + "confidence": 0.831, + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + } + }, + "content": "3/5/2021 B456 Document Fee 3 $10.00 5% $30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.121, + 0.592, + 6.121 + ] + } + ], + "confidence": 0.941, + "spans": [ + { + "offset": 660, + "length": 45 + } + ] + }, + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ] + } + ], + "confidence": 0.959, + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-06", + "content": "3/6/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ] + } + ], + "confidence": 0.903, + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Printing Fee", + "content": "Printing Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.345, + 6.2906, + 3.1351, + 6.2906, + 3.1351, + 6.4281, + 2.345, + 6.4281 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "C789", + "content": "C789", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ] + } + ], + "confidence": 0.898, + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 10, + "content": "10", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ] + } + ], + "confidence": 0.903, + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + "Tax": { + "type": "number", + "content": "20%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ] + } + ], + "confidence": 0.791, + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + "Unit": { + "type": "string", + "valueString": "pages", + "content": "pages", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 1, + "content": "$1.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ] + } + ], + "confidence": 0.829, + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + } + }, + "content": "3/6/2021 C789 Printing Fee 10 pages $1.00 20% $10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4281, + 0.592, + 6.4281 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 706, + "length": 52 + } + ] + } + ] + }, + "Locale": { + "type": "string", + "valueString": "en-US", + "confidence": 1 + }, + "PreviousUnpaidBalance": { + "type": "number", + "valueNumber": 500, + "content": "$500.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ] + } + ], + "confidence": 0.962, + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + "PurchaseOrder": { + "type": "string", + "valueString": "PO-3333", + "content": "PO-3333", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ] + } + ], + "confidence": 0.967, + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + "RemittanceAddress": { + "type": "string", + "valueString": "123 Remit St New York, NY, 10001", + "content": "123 Remit St New York, NY, 10001", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 9.5717, + 1.9882, + 9.5717, + 1.9882, + 9.9098, + 0.5943, + 9.9098 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 913, + "length": 32 + } + ] + }, + "RemittanceAddressRecipient": { + "type": "string", + "valueString": "Contoso Billing", + "content": "Contoso Billing", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5882, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 0.5882, + 9.5059 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 897, + "length": 15 + } + ] + }, + "ServiceAddress": { + "type": "string", + "valueString": "123 Service St, Redmond WA, 98052", + "content": "123 Service St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2197, + 3.9734, + 7.6337, + 3.9734, + 7.6337, + 4.3082, + 6.2197, + 4.3082 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 402, + "length": 15 + }, + { + "offset": 454, + "length": 17 + } + ] + }, + "ServiceAddressRecipient": { + "type": "string", + "valueString": "Microsoft Services", + "content": "Microsoft Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2197, + 3.7641, + 7.4427, + 3.7641, + 7.4427, + 3.8794, + 6.2197, + 3.8794 + ] + } + ], + "confidence": 0.951, + "spans": [ + { + "offset": 357, + "length": 18 + } + ] + }, + "ServiceEndDate": { + "type": "date", + "valueDate": "2019-11-14", + "content": "11/14/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2528, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 7.2528, + 2.3615 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 204, + "length": 10 + } + ] + }, + "ServiceStartDate": { + "type": "date", + "valueDate": "2019-10-14", + "content": "10/14/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.3357, + 2.2306, + 7.0749, + 2.2306, + 7.0749, + 2.3615, + 6.3357, + 2.3615 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 191, + "length": 10 + } + ] + }, + "ShippingAddress": { + "type": "string", + "valueString": "123 Ship St, Redmond WA, 98052", + "content": "123 Ship St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3454, + 3.9681, + 4.7594, + 3.9681, + 4.7594, + 4.3082, + 3.3454, + 4.3082 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 389, + "length": 12 + }, + { + "offset": 436, + "length": 17 + } + ] + }, + "ShippingAddressRecipient": { + "type": "string", + "valueString": "Microsoft Delivery", + "content": "Microsoft Delivery", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3454, + 3.7641, + 4.5762, + 3.7641, + 4.5762, + 3.9076, + 3.3454, + 3.9076 + ] + } + ], + "confidence": 0.955, + "spans": [ + { + "offset": 338, + "length": 18 + } + ] + }, + "SubTotal": { + "type": "number", + "valueNumber": 100, + "content": "$100.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + "TotalTax": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + "VendorAddress": { + "type": "string", + "valueString": "123 456th St New York, NY, 10001", + "content": "123 456th St New York, NY, 10001", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 1.6092, + 1.9894, + 1.6092, + 1.9894, + 1.9675, + 0.5943, + 1.9675 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 59, + "length": 12 + }, + { + "offset": 97, + "length": 19 + } + ] + }, + "VendorAddressRecipient": { + "type": "string", + "valueString": "Contoso Headquarters", + "content": "Contoso Headquarters", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5882, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 0.5882, + 1.5664 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 21, + "length": 20 + } + ] + }, + "VendorName": { + "type": "string", + "valueString": "CONTOSO LTD.", + "content": "CONTOSO LTD.", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5911, + 0.6857, + 2.3181, + 0.6857, + 2.3181, + 0.8664, + 0.5911, + 0.8664 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 0, + "length": 12 + } + ] + } + }, + "confidence": 1, + "spans": [ + { + "offset": 0, + "length": 958 + } + ] + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetClassifyDocumentResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetClassifyDocumentResult.json index 65b5cddd9c49..463f03b9ac35 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetClassifyDocumentResult.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetClassifyDocumentResult.json @@ -1,104 +1,104 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "classifierId": "myClassifier", - "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" - }, - "responses": { - "200": { - "body": { - "status": "succeeded", - "createdDateTime": "2021-09-24T13:00:46Z", - "lastUpdatedDateTime": "2021-09-24T13:00:49Z", - "analyzeResult": { - "apiVersion": "2023-02-28-preview", - "modelId": "myClassifier", - "stringIndexType": "textElements", - "content": "", - "pages": [ - { - "kind": "document", - "pageNumber": 1, - "width": 8.5, - "height": 11, - "unit": "inch", - "spans": [] - }, - { - "kind": "document", - "pageNumber": 2, - "width": 8.5, - "height": 11, - "unit": "inch", - "spans": [] - }, - { - "kind": "document", - "pageNumber": 3, - "width": 8.5, - "height": 11, - "unit": "inch", - "spans": [] - } - ], - "documents": [ - { - "docType": "formA", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - }, - { - "pageNumber": 2, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "confidence": 0.97, - "spans": [] - }, - { - "docType": "formB", - "boundingRegions": [ - { - "pageNumber": 3, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "confidence": 0.97, - "spans": [] - } - ] - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "classifierId": "myClassifier", + "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2021-09-24T13:00:46Z", + "lastUpdatedDateTime": "2021-09-24T13:00:49Z", + "analyzeResult": { + "apiVersion": "2023-02-28-preview", + "modelId": "myClassifier", + "stringIndexType": "textElements", + "content": "", + "pages": [ + { + "kind": "document", + "pageNumber": 1, + "width": 8.5, + "height": 11, + "unit": "inch", + "spans": [] + }, + { + "kind": "document", + "pageNumber": 2, + "width": 8.5, + "height": 11, + "unit": "inch", + "spans": [] + }, + { + "kind": "document", + "pageNumber": 3, + "width": 8.5, + "height": 11, + "unit": "inch", + "spans": [] + } + ], + "documents": [ + { + "docType": "formA", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + }, + { + "pageNumber": 2, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "confidence": 0.97, + "spans": [] + }, + { + "docType": "formB", + "boundingRegions": [ + { + "pageNumber": 3, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "confidence": 0.97, + "spans": [] + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifier.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifier.json index e42adaf9e2d9..229e119c518b 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifier.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifier.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "classifierId": "myClassifier" - }, - "responses": { - "200": { - "body": { - "classifierId": "myClassifier", - "description": "Classifier description", - "createdDateTime": "2022-07-30T00:00:00Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-02-28-preview", - "docTypes": { - "formA": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formADocs/" - } - }, - "formB": { - "azureBlobFileListSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "fileList": "formB.jsonl" - } - } - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "classifierId": "myClassifier" + }, + "responses": { + "200": { + "body": { + "classifierId": "myClassifier", + "description": "Classifier description", + "createdDateTime": "2022-07-30T00:00:00Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-02-28-preview", + "docTypes": { + "formA": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formADocs/" + } + }, + "formB": { + "azureBlobFileListSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "fileList": "formB.jsonl" + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifiers.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifiers.json index aa9bc171fd40..13a20797656b 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifiers.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentClassifiers.json @@ -1,57 +1,57 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "classifierId": "classifier1", - "description": "Classifier1 description", - "createdDateTime": "2022-07-30T00:00:00Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-02-28-preview", - "docTypes": { - "formA": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formADocs/" - } - }, - "formB": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formBDocs/" - } - } - } - }, - { - "classifierId": "classifier2", - "description": "Classifier2 description", - "createdDateTime": "2022-07-30T00:00:00Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-02-28-preview", - "docTypes": { - "formB": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formBDocs/" - } - }, - "formC": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formCDocs/" - } - } - } - } - ], - "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers?nextLink=nextLinkData" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "classifierId": "classifier1", + "description": "Classifier1 description", + "createdDateTime": "2022-07-30T00:00:00Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-02-28-preview", + "docTypes": { + "formA": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formADocs/" + } + }, + "formB": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formBDocs/" + } + } + } + }, + { + "classifierId": "classifier2", + "description": "Classifier2 description", + "createdDateTime": "2022-07-30T00:00:00Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-02-28-preview", + "docTypes": { + "formB": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formBDocs/" + } + }, + "formC": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formCDocs/" + } + } + } + } + ], + "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers?nextLink=nextLinkData" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Custom.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Custom.json index 0917c51af2a5..0ce05931c2a1 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Custom.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Custom.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "myCustomModel" - }, - "responses": { - "200": { - "body": { - "modelId": "myCustomModel", - "description": "Custom model description", - "createdDateTime": "2021-09-24T12:54:35Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-02-28-preview", - "docTypes": { - "myForm": { - "fieldSchema": { - "Name": { - "type": "string" - }, - "Date": { - "type": "date" - }, - "Amount": { - "type": "number" - } - }, - "buildMode": "template", - "fieldConfidence": { - "Name": 0.9, - "Date": 0.95, - "Amount": 0.93 - } - } - }, - "tags": { - "createdBy": "myUserId" - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "myCustomModel" + }, + "responses": { + "200": { + "body": { + "modelId": "myCustomModel", + "description": "Custom model description", + "createdDateTime": "2021-09-24T12:54:35Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-02-28-preview", + "docTypes": { + "myForm": { + "fieldSchema": { + "Name": { + "type": "string" + }, + "Date": { + "type": "date" + }, + "Amount": { + "type": "number" + } + }, + "buildMode": "template", + "fieldConfidence": { + "Name": 0.9, + "Date": 0.95, + "Amount": 0.93 + } + } + }, + "tags": { + "createdBy": "myUserId" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Prebuilt.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Prebuilt.json index 71eb2e816e55..99d5a85406cb 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Prebuilt.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModel_Prebuilt.json @@ -1,134 +1,134 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "modelId": "prebuilt-invoice" - }, - "responses": { - "200": { - "body": { - "modelId": "prebuilt-invoice", - "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.", - "createdDateTime": "2021-07-30T00:00:00Z", - "apiVersion": "2023-02-28-preview", - "docTypes": { - "prebuilt:invoice": { - "fieldSchema": { - "CustomerName": { - "type": "string" - }, - "CustomerId": { - "type": "string" - }, - "PurchaseOrder": { - "type": "string" - }, - "InvoiceId": { - "type": "string" - }, - "InvoiceDate": { - "type": "date" - }, - "DueDate": { - "type": "date" - }, - "VendorName": { - "type": "string" - }, - "VendorAddress": { - "type": "string" - }, - "VendorAddressRecipient": { - "type": "string" - }, - "CustomerAddress": { - "type": "string" - }, - "CustomerAddressRecipient": { - "type": "string" - }, - "BillingAddress": { - "type": "string" - }, - "BillingAddressRecipient": { - "type": "string" - }, - "ShippingAddress": { - "type": "string" - }, - "ShippingAddressRecipient": { - "type": "string" - }, - "SubTotal": { - "type": "number" - }, - "TotalTax": { - "type": "number" - }, - "InvoiceTotal": { - "type": "number" - }, - "AmountDue": { - "type": "number" - }, - "PreviousUnpaidBalance": { - "type": "number" - }, - "RemittanceAddress": { - "type": "string" - }, - "RemittanceAddressRecipient": { - "type": "string" - }, - "ServiceAddress": { - "type": "string" - }, - "ServiceAddressRecipient": { - "type": "string" - }, - "ServiceStartDate": { - "type": "date" - }, - "ServiceEndDate": { - "type": "date" - }, - "Items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Amount": { - "type": "number" - }, - "Date": { - "type": "date" - }, - "Description": { - "type": "string" - }, - "Quantity": { - "type": "number" - }, - "ProductCode": { - "type": "string" - }, - "Tax": { - "type": "number" - }, - "Unit": { - "type": "string" - }, - "UnitPrice": { - "type": "number" - } - } - } - } - } - } - }, - "tags": {} - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "modelId": "prebuilt-invoice" + }, + "responses": { + "200": { + "body": { + "modelId": "prebuilt-invoice", + "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.", + "createdDateTime": "2021-07-30T00:00:00Z", + "apiVersion": "2023-02-28-preview", + "docTypes": { + "prebuilt:invoice": { + "fieldSchema": { + "CustomerName": { + "type": "string" + }, + "CustomerId": { + "type": "string" + }, + "PurchaseOrder": { + "type": "string" + }, + "InvoiceId": { + "type": "string" + }, + "InvoiceDate": { + "type": "date" + }, + "DueDate": { + "type": "date" + }, + "VendorName": { + "type": "string" + }, + "VendorAddress": { + "type": "string" + }, + "VendorAddressRecipient": { + "type": "string" + }, + "CustomerAddress": { + "type": "string" + }, + "CustomerAddressRecipient": { + "type": "string" + }, + "BillingAddress": { + "type": "string" + }, + "BillingAddressRecipient": { + "type": "string" + }, + "ShippingAddress": { + "type": "string" + }, + "ShippingAddressRecipient": { + "type": "string" + }, + "SubTotal": { + "type": "number" + }, + "TotalTax": { + "type": "number" + }, + "InvoiceTotal": { + "type": "number" + }, + "AmountDue": { + "type": "number" + }, + "PreviousUnpaidBalance": { + "type": "number" + }, + "RemittanceAddress": { + "type": "string" + }, + "RemittanceAddressRecipient": { + "type": "string" + }, + "ServiceAddress": { + "type": "string" + }, + "ServiceAddressRecipient": { + "type": "string" + }, + "ServiceStartDate": { + "type": "date" + }, + "ServiceEndDate": { + "type": "date" + }, + "Items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Amount": { + "type": "number" + }, + "Date": { + "type": "date" + }, + "Description": { + "type": "string" + }, + "Quantity": { + "type": "number" + }, + "ProductCode": { + "type": "string" + }, + "Tax": { + "type": "number" + }, + "Unit": { + "type": "string" + }, + "UnitPrice": { + "type": "number" + } + } + } + } + } + } + }, + "tags": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModels.json index f6d133837115..c4957ba19785 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModels.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetDocumentModels.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "modelId": "prebuilt-layout", - "createdDateTime": "2021-07-30T00:00:00Z", - "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.", - "apiVersion": "2023-02-28-preview" - }, - { - "modelId": "myCustomModel", - "createdDateTime": "2021-09-24T12:54:35Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "description": "Custom model description", - "apiVersion": "2023-02-28-preview" - } - ], - "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels?nextLink=nextLinkData" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "modelId": "prebuilt-layout", + "createdDateTime": "2021-07-30T00:00:00Z", + "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.", + "apiVersion": "2023-02-28-preview" + }, + { + "modelId": "myCustomModel", + "createdDateTime": "2021-09-24T12:54:35Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "description": "Custom model description", + "apiVersion": "2023-02-28-preview" + } + ], + "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels?nextLink=nextLinkData" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperation.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperation.json index 8a0d0e96a2d8..af1f7e48cba5 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperation.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperation.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview", - "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4" - }, - "responses": { - "200": { - "body": { - "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4", - "status": "succeeded", - "percentCompleted": 100, - "createdDateTime": "2021-09-23T09:12:57Z", - "lastUpdatedDateTime": "2021-09-23T09:13:01Z", - "kind": "documentModelBuild", - "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", - "result": { - "modelId": "myCustomModel", - "description": "Custom model description", - "createdDateTime": "2021-09-23T09:13:01Z", - "apiVersion": "2023-02-28-preview" - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview", + "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4" + }, + "responses": { + "200": { + "body": { + "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4", + "status": "succeeded", + "percentCompleted": 100, + "createdDateTime": "2021-09-23T09:12:57Z", + "lastUpdatedDateTime": "2021-09-23T09:13:01Z", + "kind": "documentModelBuild", + "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", + "result": { + "modelId": "myCustomModel", + "description": "Custom model description", + "createdDateTime": "2021-09-23T09:13:01Z", + "apiVersion": "2023-02-28-preview" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperations.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperations.json index df4616e8bf85..16a81d490b8d 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperations.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetOperations.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4", - "status": "running", - "percentCompleted": 0, - "createdDateTime": "2021-09-23T09:12:57Z", - "lastUpdatedDateTime": "2021-09-23T09:12:58Z", - "kind": "documentModelBuild", - "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", - "apiVersion": "2023-02-28-preview" - } - ], - "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4", + "status": "running", + "percentCompleted": 0, + "createdDateTime": "2021-09-23T09:12:57Z", + "lastUpdatedDateTime": "2021-09-23T09:12:58Z", + "kind": "documentModelBuild", + "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", + "apiVersion": "2023-02-28-preview" + } + ], + "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetResourceDetails.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetResourceDetails.json index de35e88df1d9..cbe0761545ff 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetResourceDetails.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/2023-02-28-preview/examples/GetResourceDetails.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-02-28-preview" - }, - "responses": { - "200": { - "body": { - "customDocumentModels": { - "count": 2, - "limit": 13 - }, - "customNeuralDocumentModelBuilds": { - "used": 1, - "quota": 10, - "quotaResetDateTime": "2023-03-01T00:00:00Z" - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-02-28-preview" + }, + "responses": { + "200": { + "body": { + "customDocumentModels": { + "count": 2, + "limit": 13 + }, + "customNeuralDocumentModelBuilds": { + "used": 1, + "quota": 10, + "quotaResetDateTime": "2023-03-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/FormRecognizer.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/FormRecognizer.json index 1dead32e2159..05e2f4f08868 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/FormRecognizer.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/FormRecognizer.json @@ -1,2220 +1,2220 @@ -{ - "swagger": "2.0", - "info": { - "title": "Form Recognizer Client", - "description": "Extracts content, layout, and structured data from documents.", - "version": "2022-08-31" - }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/formrecognizer", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "schemes": [ - "https" - ], - "paths": { - "/documentModels/{modelId}:analyze": { - "post": { - "summary": "Analyze document", - "description": "Analyzes document with document model.", - "operationId": "AnalyzeDocument", - "tags": [ - "Analysis" - ], - "consumes": [ - "application/json", - "application/octet-stream", - "application/pdf", - "image/jpeg", - "image/png", - "image/tiff", - "image/bmp", - "image/heif" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/PathDocumentModelId" - }, - { - "$ref": "#/parameters/QueryPages" - }, - { - "$ref": "#/parameters/QueryLocale" - }, - { - "$ref": "#/parameters/QueryStringIndexType" - }, - { - "$ref": "#/parameters/QueryApiVersion" - }, - { - "name": "analyzeRequest", - "description": "Analyze request parameters.", - "required": false, - "in": "body", - "schema": { - "$ref": "#/definitions/AnalyzeDocumentRequest" - } - } - ], - "responses": { - "202": { - "description": "Request is queued successfully.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "URL used to track the progress and obtain the result of the analyze operation." - } - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "AnalyzeDocument_Url": { - "$ref": "./examples/AnalyzeDocument_Url.json" - }, - "AnalyzeDocument_Base64": { - "$ref": "./examples/AnalyzeDocument_Base64.json" - } - } - } - }, - "/documentModels/{modelId}/analyzeResults/{resultId}": { - "get": { - "summary": "Get analyze result", - "description": "Gets the result of document analysis.", - "operationId": "GetAnalyzeDocumentResult", - "tags": [ - "Analysis" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/PathDocumentModelId" - }, - { - "$ref": "#/parameters/PathResultId" - }, - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/AnalyzeResultOperation" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetAnalyzeDocumentResult": { - "$ref": "./examples/GetAnalyzeDocumentResult.json" - } - } - } - }, - "/documentModels:build": { - "post": { - "summary": "Build document model", - "description": "Builds a custom document analysis model.", - "operationId": "BuildDocumentModel", - "tags": [ - "Creation" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/QueryApiVersion" - }, - { - "name": "buildRequest", - "description": "Building request parameters.", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/BuildDocumentModelRequest" - } - } - ], - "responses": { - "202": { - "description": "Request is queued successfully.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "Operation result URL." - } - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "BuildDocumentModel": { - "$ref": "./examples/BuildDocumentModel.json" - } - } - } - }, - "/documentModels:compose": { - "post": { - "summary": "Compose document model", - "description": "Creates a new document model from document types of existing document models.", - "operationId": "ComposeDocumentModel", - "tags": [ - "Creation" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/QueryApiVersion" - }, - { - "name": "composeRequest", - "description": "Compose request parameters.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ComposeDocumentModelRequest" - } - } - ], - "responses": { - "202": { - "description": "Request is queued successfully.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "Operation result URL." - } - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "ComposeDocumentModel": { - "$ref": "./examples/ComposeDocumentModel.json" - } - } - } - }, - "/documentModels:authorizeCopy": { - "post": { - "summary": "Generate copy authorization", - "description": "Generates authorization to copy a document model to this location with specified modelId and optional description.", - "operationId": "AuthorizeCopyDocumentModel", - "tags": [ - "Creation" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/QueryApiVersion" - }, - { - "name": "authorizeCopyRequest", - "description": "Authorize copy request parameters.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AuthorizeCopyRequest" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/CopyAuthorization" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "AuthorizeCopyDocumentModel": { - "$ref": "./examples/AuthorizeCopyDocumentModel.json" - } - } - } - }, - "/documentModels/{modelId}:copyTo": { - "post": { - "summary": "Copy document model", - "description": "Copies document model to the target resource, region, and modelId.", - "operationId": "CopyDocumentModelTo", - "tags": [ - "Creation" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/PathDocumentModelId" - }, - { - "$ref": "#/parameters/QueryApiVersion" - }, - { - "name": "copyToRequest", - "description": "Copy to request parameters.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CopyAuthorization" - } - } - ], - "responses": { - "202": { - "description": "Request is queued successfully.", - "headers": { - "Operation-Location": { - "type": "string", - "description": "Operation result URL." - } - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "CopyDocumentModelTo": { - "$ref": "./examples/CopyDocumentModelTo.json" - } - } - } - }, - "/operations": { - "get": { - "summary": "List operations", - "description": "Lists all operations.", - "operationId": "GetOperations", - "tags": [ - "Operation" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/GetOperationsResponse" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "x-ms-examples": { - "GetOperations": { - "$ref": "./examples/GetOperations.json" - } - } - } - }, - "/operations/{operationId}": { - "get": { - "summary": "Get operation", - "description": "Gets operation info.", - "operationId": "GetOperation", - "tags": [ - "Operation" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/PathOperationId" - }, - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/OperationDetails" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetOperation": { - "$ref": "./examples/GetOperation.json" - } - } - } - }, - "/documentModels": { - "get": { - "summary": "List document models", - "description": "List all document models", - "operationId": "GetDocumentModels", - "tags": [ - "Management" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/GetDocumentModelsResponse" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "x-ms-examples": { - "GetDocumentModels": { - "$ref": "./examples/GetDocumentModels.json" - } - } - } - }, - "/documentModels/{modelId}": { - "get": { - "summary": "Get document model", - "description": "Gets detailed document model information.", - "operationId": "GetDocumentModel", - "tags": [ - "Management" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/PathDocumentModelId" - }, - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/DocumentModelDetails" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetDocumentModel_Prebuilt": { - "$ref": "./examples/GetDocumentModel_Prebuilt.json" - }, - "GetDocumentModel_Custom": { - "$ref": "./examples/GetDocumentModel_Custom.json" - } - } - }, - "delete": { - "summary": "Delete document model", - "description": "Deletes document model.", - "operationId": "DeleteDocumentModel", - "tags": [ - "Management" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/PathDocumentModelId" - }, - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "204": { - "description": "Deleting document model." - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "DeleteDocumentModel": { - "$ref": "./examples/DeleteDocumentModel.json" - } - } - } - }, - "/info": { - "get": { - "summary": "Get resource info", - "description": "Return information about the current resource.", - "operationId": "GetResourceDetails", - "tags": [ - "Management" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/QueryApiVersion" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/ResourceDetails" - } - }, - "default": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetResourceDetails": { - "$ref": "./examples/GetResourceDetails.json" - } - } - } - } - }, - "definitions": { - "AnalyzeDocumentRequest": { - "description": "Document analysis parameters.", - "type": "object", - "properties": { - "urlSource": { - "description": "Document URL to analyze", - "$ref": "#/definitions/UrlContentSource" - }, - "base64Source": { - "description": "Base64 encoding of the document to analyze", - "$ref": "#/definitions/Base64ContentSource" - } - } - }, - "BuildDocumentModelRequest": { - "description": "Request body to build a new custom document model.", - "type": "object", - "required": [ - "modelId", - "buildMode" - ], - "properties": { - "modelId": { - "$ref": "#/definitions/DocumentModelId" - }, - "description": { - "$ref": "#/definitions/DocumentModelDescription" - }, - "buildMode": { - "$ref": "#/definitions/DocumentBuildMode" - }, - "azureBlobSource": { - "description": "Azure Blob Storage location containing the training data.", - "$ref": "#/definitions/AzureBlobContentSource" - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ComposeDocumentModelRequest": { - "description": "Request body to create a composed document model from component document models.", - "type": "object", - "required": [ - "modelId", - "componentModels" - ], - "properties": { - "modelId": { - "$ref": "#/definitions/DocumentModelId" - }, - "description": { - "$ref": "#/definitions/DocumentModelDescription" - }, - "componentModels": { - "description": "List of component document models to compose.", - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/definitions/ComponentDocumentModelDetails" - } - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ComponentDocumentModelDetails": { - "description": "A component of a composed document model.", - "type": "object", - "required": [ - "modelId" - ], - "properties": { - "modelId": { - "$ref": "#/definitions/DocumentModelId" - } - } - }, - "AuthorizeCopyRequest": { - "description": "Request body to authorize document model copy.", - "type": "object", - "required": [ - "modelId" - ], - "properties": { - "modelId": { - "$ref": "#/definitions/DocumentModelId" - }, - "description": { - "$ref": "#/definitions/DocumentModelDescription" - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GetOperationsResponse": { - "description": "List Operations response object.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "description": "List of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationSummary" - } - }, - "nextLink": { - "description": "Link to the next page of operations.", - "type": "string" - } - } - }, - "OperationDetails": { - "description": "Get Operation response object.", - "type": "object", - "discriminator": "kind", - "required": [ - "operationId", - "status", - "createdDateTime", - "lastUpdatedDateTime", - "kind", - "resourceLocation" - ], - "properties": { - "operationId": { - "description": "Operation ID", - "type": "string" - }, - "status": { - "description": "Operation status.", - "type": "string", - "enum": [ - "notStarted", - "running", - "failed", - "succeeded", - "canceled" - ], - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": false - } - }, - "percentCompleted": { - "description": "Operation progress (0-100).", - "type": "integer", - "format": "int32", - "minimum": 0, - "maximum": 100 - }, - "createdDateTime": { - "description": "Date and time (UTC) when the operation was created.", - "type": "string", - "format": "date-time" - }, - "lastUpdatedDateTime": { - "description": "Date and time (UTC) when the status was last updated.", - "type": "string", - "format": "date-time" - }, - "kind": { - "description": "Type of operation.", - "type": "string" - }, - "resourceLocation": { - "description": "URL of the resource targeted by this operation.", - "type": "string" - }, - "apiVersion": { - "description": "API version used to create this operation.", - "type": "string" - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "error": { - "description": "Encountered error.", - "$ref": "#/definitions/Error" - } - } - }, - "DocumentModelBuildOperationDetails": { - "description": "Get Operation response object.", - "x-ms-discriminator-value": "documentModelBuild", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OperationDetails" - } - ], - "properties": { - "result": { - "description": "Operation result upon success.", - "$ref": "#/definitions/DocumentModelDetails" - } - } - }, - "DocumentModelComposeOperationDetails": { - "description": "Get Operation response object.", - "x-ms-discriminator-value": "documentModelCompose", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OperationDetails" - } - ], - "properties": { - "result": { - "description": "Operation result upon success.", - "$ref": "#/definitions/DocumentModelDetails" - } - } - }, - "DocumentModelCopyToOperationDetails": { - "description": "Get Operation response object.", - "x-ms-discriminator-value": "documentModelCopyTo", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OperationDetails" - } - ], - "properties": { - "result": { - "description": "Operation result upon success.", - "$ref": "#/definitions/DocumentModelDetails" - } - } - }, - "GetDocumentModelsResponse": { - "description": "List document models response object.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "description": "List of document models.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentModelSummary" - } - }, - "nextLink": { - "description": "Link to the next page of document models.", - "type": "string" - } - } - }, - "ResourceDetails": { - "description": "General information regarding the current resource.", - "type": "object", - "required": [ - "customDocumentModels" - ], - "properties": { - "customDocumentModels": { - "$ref": "#/definitions/CustomDocumentModelsDetails" - } - } - }, - "CustomDocumentModelsDetails": { - "description": "Details regarding custom document models.", - "type": "object", - "required": [ - "count", - "limit" - ], - "properties": { - "count": { - "description": "Number of custom document models in the current resource.", - "type": "integer", - "format": "int32" - }, - "limit": { - "description": "Maximum number of custom document models supported in the current resource.", - "type": "integer", - "format": "int32" - } - } - }, - "ApiVersion": { - "description": "API version.", - "type": "string", - "enum": [ - "2022-08-31" - ], - "x-ms-enum": { - "name": "ApiVersion", - "modelAsString": true - } - }, - "ErrorResponse": { - "description": "Error response object.", - "type": "object", - "required": [ - "error" - ], - "properties": { - "error": { - "$ref": "#/definitions/Error" - } - } - }, - "Error": { - "description": "Error info.", - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message.", - "type": "string" - }, - "target": { - "description": "Target of the error.", - "type": "string" - }, - "details": { - "description": "List of detailed errors.", - "type": "array", - "items": { - "$ref": "#/definitions/Error" - } - }, - "innererror": { - "$ref": "#/definitions/InnerError" - } - } - }, - "InnerError": { - "description": "Detailed error.", - "type": "object", - "required": [ - "code" - ], - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message.", - "type": "string" - }, - "innererror": { - "$ref": "#/definitions/InnerError" - } - } - }, - "UrlContentSource": { - "description": "Content at specified URL.", - "type": "string", - "format": "uri" - }, - "Base64ContentSource": { - "description": "Content represented via Base64 encoding.", - "type": "string", - "format": "byte" - }, - "AzureBlobContentSource": { - "description": "Azure Blob Storage content.", - "type": "object", - "required": [ - "containerUrl" - ], - "properties": { - "containerUrl": { - "description": "Azure Blob Storage container URL.", - "type": "string", - "format": "uri" - }, - "prefix": { - "description": "Blob name prefix.", - "type": "string" - } - } - }, - "CopyAuthorization": { - "description": "Authorization to copy a document model to the specified target resource and modelId.", - "type": "object", - "required": [ - "targetResourceId", - "targetResourceRegion", - "targetModelId", - "targetModelLocation", - "accessToken", - "expirationDateTime" - ], - "properties": { - "targetResourceId": { - "description": "ID of the target Azure resource where the document model should be copied to.", - "type": "string", - "x-ms-azure-resource": true - }, - "targetResourceRegion": { - "description": "Location of the target Azure resource where the document model should be copied to.", - "type": "string" - }, - "targetModelId": { - "description": "Identifier of the target document model.", - "$ref": "#/definitions/DocumentModelId" - }, - "targetModelLocation": { - "description": "URL of the copied document model in the target account.", - "type": "string" - }, - "accessToken": { - "description": "Token used to authorize the request.", - "type": "string" - }, - "expirationDateTime": { - "description": "Date/time when the access token expires.", - "type": "string", - "format": "date-time" - } - } - }, - "OperationSummary": { - "description": "Operation info.", - "type": "object", - "required": [ - "operationId", - "status", - "createdDateTime", - "lastUpdatedDateTime", - "kind", - "resourceLocation" - ], - "properties": { - "operationId": { - "description": "Operation ID", - "type": "string" - }, - "status": { - "description": "Operation status.", - "type": "string", - "enum": [ - "notStarted", - "running", - "failed", - "succeeded", - "canceled" - ], - "x-ms-enum": { - "name": "OperationStatus", - "modelAsString": false - } - }, - "percentCompleted": { - "description": "Operation progress (0-100).", - "type": "integer", - "format": "int32", - "minimum": 0, - "maximum": 100 - }, - "createdDateTime": { - "description": "Date and time (UTC) when the operation was created.", - "type": "string", - "format": "date-time" - }, - "lastUpdatedDateTime": { - "description": "Date and time (UTC) when the status was last updated.", - "type": "string", - "format": "date-time" - }, - "kind": { - "description": "Type of operation.", - "type": "string", - "enum": [ - "documentModelBuild", - "documentModelCompose", - "documentModelCopyTo" - ], - "x-ms-enum": { - "name": "OperationKind", - "modelAsString": true - } - }, - "resourceLocation": { - "description": "URL of the resource targeted by this operation.", - "type": "string" - }, - "apiVersion": { - "description": "API version used to create this operation.", - "type": "string" - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "DocumentModelSummary": { - "description": "Document model summary.", - "type": "object", - "required": [ - "modelId", - "createdDateTime" - ], - "properties": { - "modelId": { - "$ref": "#/definitions/DocumentModelId" - }, - "description": { - "$ref": "#/definitions/DocumentModelDescription" - }, - "createdDateTime": { - "description": "Date and time (UTC) when the document model was created.", - "type": "string", - "format": "date-time" - }, - "apiVersion": { - "description": "API version used to create this document model.", - "type": "string" - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "DocumentModelDetails": { - "description": "Document model info.", - "type": "object", - "required": [ - "modelId", - "createdDateTime" - ], - "properties": { - "modelId": { - "$ref": "#/definitions/DocumentModelId" - }, - "description": { - "$ref": "#/definitions/DocumentModelDescription" - }, - "createdDateTime": { - "description": "Date and time (UTC) when the document model was created.", - "type": "string", - "format": "date-time" - }, - "apiVersion": { - "description": "API version used to create this document model.", - "type": "string" - }, - "tags": { - "description": "List of key-value tag attributes associated with the document model.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "docTypes": { - "description": "Supported document types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DocumentTypeDetails" - } - } - } - }, - "DocumentTypeDetails": { - "description": "Document type info.", - "type": "object", - "required": [ - "fieldSchema" - ], - "properties": { - "description": { - "$ref": "#/definitions/DocumentModelDescription" - }, - "buildMode": { - "$ref": "#/definitions/DocumentBuildMode" - }, - "fieldSchema": { - "$ref": "#/definitions/DocTypeSchema" - }, - "fieldConfidence": { - "description": "Estimated confidence for each field.", - "type": "object", - "additionalProperties": { - "type": "number", - "minimum": 0, - "maximum": 1 - } - } - } - }, - "DocTypeSchema": { - "description": "Description of the document semantic schema using a JSON Schema style syntax.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DocumentFieldSchema" - } - }, - "DocumentFieldSchema": { - "description": "Description of the field semantic schema using a JSON Schema style syntax.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "$ref": "#/definitions/DocumentFieldType" - }, - "description": { - "description": "Field description.", - "type": "string" - }, - "example": { - "description": "Example field content.", - "type": "string" - }, - "items": { - "description": "Field type schema of each array element.", - "$ref": "#/definitions/DocumentFieldSchema" - }, - "properties": { - "description": "Named sub-fields of the object field.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DocumentFieldSchema" - } - } - } - }, - "AnalyzeResultOperation": { - "description": "Status and result of the analyze operation.", - "type": "object", - "required": [ - "status", - "createdDateTime", - "lastUpdatedDateTime" - ], - "properties": { - "status": { - "description": "Operation status.", - "type": "string", - "enum": [ - "notStarted", - "running", - "failed", - "succeeded" - ], - "x-ms-enum": { - "name": "AnalyzeResultOperationStatus", - "modelAsString": false - } - }, - "createdDateTime": { - "description": "Date and time (UTC) when the analyze operation was submitted.", - "type": "string", - "format": "date-time" - }, - "lastUpdatedDateTime": { - "description": "Date and time (UTC) when the status was last updated.", - "type": "string", - "format": "date-time" - }, - "error": { - "description": "Encountered error during document analysis.", - "$ref": "#/definitions/Error" - }, - "analyzeResult": { - "$ref": "#/definitions/AnalyzeResult" - } - } - }, - "AnalyzeResult": { - "description": "Document analysis result.", - "type": "object", - "required": [ - "apiVersion", - "modelId", - "stringIndexType", - "content", - "pages" - ], - "properties": { - "apiVersion": { - "description": "API version used to produce this result.", - "$ref": "#/definitions/ApiVersion" - }, - "modelId": { - "description": "Document model ID used to produce this result.", - "$ref": "#/definitions/DocumentModelId" - }, - "stringIndexType": { - "description": "Method used to compute string offset and length.", - "$ref": "#/definitions/StringIndexType" - }, - "content": { - "description": "Concatenate string representation of all textual and visual elements in reading order.", - "type": "string" - }, - "pages": { - "description": "Analyzed pages.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentPage" - } - }, - "paragraphs": { - "description": "Extracted paragraphs.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentParagraph" - } - }, - "tables": { - "description": "Extracted tables.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentTable" - } - }, - "keyValuePairs": { - "description": "Extracted key-value pairs.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentKeyValuePair" - } - }, - "styles": { - "description": "Extracted font styles.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentStyle" - } - }, - "languages": { - "description": "Detected languages.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentLanguage" - } - }, - "documents": { - "description": "Extracted documents.", - "type": "array", - "items": { - "$ref": "#/definitions/Document" - } - } - } - }, - "DocumentPage": { - "description": "Content and layout elements extracted from a page from the input.", - "type": "object", - "required": [ - "pageNumber", - "spans" - ], - "properties": { - "pageNumber": { - "description": "1-based page number in the input document.", - "type": "integer", - "format": "int32", - "minimum": 1 - }, - "angle": { - "description": "The general orientation of the content in clockwise direction, measured in degrees between (-180, 180].", - "type": "number", - "minimum": -180, - "maximum": 180, - "exclusiveMinimum": true - }, - "width": { - "description": "The width of the image/PDF in pixels/inches, respectively.", - "type": "number", - "minimum": 0 - }, - "height": { - "description": "The height of the image/PDF in pixels/inches, respectively.", - "type": "number", - "minimum": 0 - }, - "unit": { - "description": "The unit used by the width, height, and polygon properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\".", - "type": "string", - "enum": [ - "pixel", - "inch" - ], - "x-ms-enum": { - "name": "LengthUnit", - "modelAsString": true - } - }, - "spans": { - "description": "Location of the page in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - }, - "words": { - "description": "Extracted words from the page.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentWord" - } - }, - "selectionMarks": { - "description": "Extracted selection marks from the page.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSelectionMark" - } - }, - "lines": { - "description": "Extracted lines from the page, potentially containing both textual and visual elements.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentLine" - } - } - } - }, - "DocumentWord": { - "description": "A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.", - "type": "object", - "required": [ - "content", - "span", - "confidence" - ], - "properties": { - "content": { - "description": "Text content of the word.", - "type": "string" - }, - "polygon": { - "description": "Bounding polygon of the word.", - "$ref": "#/definitions/BoundingPolygon" - }, - "span": { - "description": "Location of the word in the reading order concatenated content.", - "$ref": "#/definitions/DocumentSpan" - }, - "confidence": { - "description": "Confidence of correctly extracting the word.", - "$ref": "#/definitions/Confidence" - } - } - }, - "DocumentSelectionMark": { - "description": "A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.", - "type": "object", - "required": [ - "state", - "span", - "confidence" - ], - "properties": { - "state": { - "description": "State of the selection mark.", - "$ref": "#/definitions/DocumentSelectionMarkState" - }, - "polygon": { - "description": "Bounding polygon of the selection mark.", - "$ref": "#/definitions/BoundingPolygon" - }, - "span": { - "description": "Location of the selection mark in the reading order concatenated content.", - "$ref": "#/definitions/DocumentSpan" - }, - "confidence": { - "description": "Confidence of correctly extracting the selection mark.", - "$ref": "#/definitions/Confidence" - } - } - }, - "DocumentSelectionMarkState": { - "description": "State of the selection mark.", - "type": "string", - "enum": [ - "selected", - "unselected" - ], - "x-ms-enum": { - "name": "SelectionMarkState", - "modelAsString": true - } - }, - "DocumentLine": { - "description": "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.", - "type": "object", - "required": [ - "content", - "spans" - ], - "properties": { - "content": { - "description": "Concatenated content of the contained elements in reading order.", - "type": "string" - }, - "polygon": { - "description": "Bounding polygon of the line.", - "$ref": "#/definitions/BoundingPolygon" - }, - "spans": { - "description": "Location of the line in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - } - } - }, - "DocumentParagraph": { - "description": "A paragraph object consisting with contiguous lines generally with common alignment and spacing.", - "type": "object", - "required": [ - "content", - "spans" - ], - "properties": { - "role": { - "description": "Semantic role of the paragraph.", - "type": "string", - "enum": [ - "pageHeader", - "pageFooter", - "pageNumber", - "title", - "sectionHeading", - "footnote" - ], - "x-ms-enum": { - "name": "ParagraphRole", - "modelAsString": true - } - }, - "content": { - "description": "Concatenated content of the paragraph in reading order.", - "type": "string" - }, - "boundingRegions": { - "description": "Bounding regions covering the paragraph.", - "type": "array", - "items": { - "$ref": "#/definitions/BoundingRegion" - } - }, - "spans": { - "description": "Location of the paragraph in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - } - } - }, - "DocumentTable": { - "description": "A table object consisting table cells arranged in a rectangular layout.", - "type": "object", - "required": [ - "rowCount", - "columnCount", - "cells", - "spans" - ], - "properties": { - "rowCount": { - "description": "Number of rows in the table.", - "type": "integer", - "format": "int32", - "minimum": 1 - }, - "columnCount": { - "description": "Number of columns in the table.", - "type": "integer", - "format": "int32", - "minimum": 1 - }, - "cells": { - "description": "Cells contained within the table.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentTableCell" - } - }, - "boundingRegions": { - "description": "Bounding regions covering the table.", - "type": "array", - "items": { - "$ref": "#/definitions/BoundingRegion" - } - }, - "spans": { - "description": "Location of the table in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - } - } - }, - "DocumentTableCell": { - "description": "An object representing the location and content of a table cell.", - "type": "object", - "required": [ - "rowIndex", - "columnIndex", - "content", - "spans" - ], - "properties": { - "kind": { - "description": "Table cell kind.", - "type": "string", - "enum": [ - "content", - "rowHeader", - "columnHeader", - "stubHead", - "description" - ], - "default": "content", - "x-ms-enum": { - "name": "DocumentTableCellKind", - "modelAsString": true - } - }, - "rowIndex": { - "description": "Row index of the cell.", - "type": "integer", - "format": "int32" - }, - "columnIndex": { - "description": "Column index of the cell.", - "type": "integer", - "format": "int32" - }, - "rowSpan": { - "description": "Number of rows spanned by this cell.", - "type": "integer", - "format": "int32", - "minimum": 1, - "default": 1 - }, - "columnSpan": { - "description": "Number of columns spanned by this cell.", - "type": "integer", - "format": "int32", - "minimum": 1, - "default": 1 - }, - "content": { - "description": "Concatenated content of the table cell in reading order.", - "type": "string" - }, - "boundingRegions": { - "description": "Bounding regions covering the table cell.", - "type": "array", - "items": { - "$ref": "#/definitions/BoundingRegion" - } - }, - "spans": { - "description": "Location of the table cell in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - } - } - }, - "DocumentKeyValuePair": { - "description": "An object representing a form field with distinct field label (key) and field value (may be empty).", - "type": "object", - "required": [ - "key", - "confidence" - ], - "properties": { - "key": { - "description": "Field label of the key-value pair.", - "$ref": "#/definitions/DocumentKeyValueElement" - }, - "value": { - "description": "Field value of the key-value pair.", - "$ref": "#/definitions/DocumentKeyValueElement" - }, - "confidence": { - "description": "Confidence of correctly extracting the key-value pair.", - "$ref": "#/definitions/Confidence" - } - } - }, - "DocumentKeyValueElement": { - "description": "An object representing the field key or value in a key-value pair.", - "type": "object", - "required": [ - "content", - "spans" - ], - "properties": { - "content": { - "description": "Concatenated content of the key-value element in reading order.", - "type": "string" - }, - "boundingRegions": { - "description": "Bounding regions covering the key-value element.", - "type": "array", - "items": { - "$ref": "#/definitions/BoundingRegion" - } - }, - "spans": { - "description": "Location of the key-value element in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - } - } - }, - "DocumentStyle": { - "description": "An object representing observed text styles.", - "type": "object", - "required": [ - "spans", - "confidence" - ], - "properties": { - "isHandwritten": { - "description": "Is content handwritten?", - "type": "boolean" - }, - "spans": { - "description": "Location of the text elements in the concatenated content the style applies to.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - }, - "confidence": { - "description": "Confidence of correctly identifying the style.", - "$ref": "#/definitions/Confidence" - } - } - }, - "DocumentLanguage": { - "description": "An object representing the detected language for a given text span.", - "type": "object", - "required": [ - "locale", - "spans", - "confidence" - ], - "properties": { - "locale": { - "description": "Detected language. Value may an ISO 639-1 language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"zh-Hans\").", - "type": "string" - }, - "spans": { - "description": "Location of the text elements in the concatenated content the language applies to.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - }, - "confidence": { - "description": "Confidence of correctly identifying the language.", - "$ref": "#/definitions/Confidence" - } - } - }, - "Document": { - "description": "An object describing the location and semantic content of a document.", - "type": "object", - "required": [ - "docType", - "spans", - "confidence" - ], - "properties": { - "docType": { - "description": "Document type.", - "$ref": "#/definitions/DocType" - }, - "boundingRegions": { - "description": "Bounding regions covering the document.", - "type": "array", - "items": { - "$ref": "#/definitions/BoundingRegion" - } - }, - "spans": { - "description": "Location of the document in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - }, - "fields": { - "description": "Dictionary of named field values.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DocumentField" - } - }, - "confidence": { - "description": "Confidence of correctly extracting the document.", - "$ref": "#/definitions/Confidence" - } - } - }, - "DocumentField": { - "description": "An object representing the content and location of a field value.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "description": "Data type of the field value.", - "$ref": "#/definitions/DocumentFieldType" - }, - "valueString": { - "description": "String value.", - "type": "string" - }, - "valueDate": { - "description": "Date value in YYYY-MM-DD format (ISO 8601).", - "type": "string", - "format": "date" - }, - "valueTime": { - "description": "Time value in hh:mm:ss format (ISO 8601).", - "type": "string", - "format": "time" - }, - "valuePhoneNumber": { - "description": "Phone number value in E.164 format (ex. +19876543210).", - "type": "string" - }, - "valueNumber": { - "description": "Floating point value.", - "type": "number" - }, - "valueInteger": { - "description": "Integer value.", - "type": "integer", - "format": "int64" - }, - "valueSelectionMark": { - "description": "Selection mark value.", - "$ref": "#/definitions/DocumentSelectionMarkState" - }, - "valueSignature": { - "description": "Presence of signature.", - "type": "string", - "enum": [ - "signed", - "unsigned" - ], - "x-ms-enum": { - "name": "DocumentSignatureType", - "modelAsString": true - } - }, - "valueCountryRegion": { - "description": "3-letter country code value (ISO 3166-1 alpha-3).", - "type": "string" - }, - "valueArray": { - "description": "Array of field values.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentField" - } - }, - "valueObject": { - "description": "Dictionary of named field values.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DocumentField" - } - }, - "valueCurrency": { - "description": "Currency value.", - "$ref": "#/definitions/CurrencyValue" - }, - "valueAddress": { - "description": "Address value.", - "$ref": "#/definitions/AddressValue" - }, - "content": { - "description": "Field content.", - "type": "string" - }, - "boundingRegions": { - "description": "Bounding regions covering the field.", - "type": "array", - "items": { - "$ref": "#/definitions/BoundingRegion" - } - }, - "spans": { - "description": "Location of the field in the reading order concatenated content.", - "type": "array", - "items": { - "$ref": "#/definitions/DocumentSpan" - } - }, - "confidence": { - "description": "Confidence of correctly extracting the field.", - "$ref": "#/definitions/Confidence" - } - } - }, - "DocumentFieldType": { - "description": "Semantic data type of the field value.", - "type": "string", - "enum": [ - "string", - "date", - "time", - "phoneNumber", - "number", - "integer", - "selectionMark", - "countryRegion", - "signature", - "array", - "object", - "currency", - "address" - ], - "x-ms-enum": { - "name": "DocumentFieldType", - "modelAsString": true - } - }, - "CurrencyValue": { - "description": "Currency field value.", - "type": "object", - "required": [ - "amount" - ], - "properties": { - "amount": { - "description": "Currency amount.", - "type": "number", - "format": "double" - }, - "currencySymbol": { - "description": "Currency symbol label, if any.", - "type": "string" - } - } - }, - "AddressValue": { - "description": "Address field value.", - "type": "object", - "properties": { - "houseNumber": { - "description": "House or building number.", - "type": "string" - }, - "poBox": { - "description": "Post office box number.", - "type": "string" - }, - "road": { - "description": "Street name.", - "type": "string" - }, - "city": { - "description": "Name of city, town, village, etc.", - "type": "string" - }, - "state": { - "description": "First-level administrative division.", - "type": "string" - }, - "postalCode": { - "description": "Postal code used for mail sorting.", - "type": "string" - }, - "countryRegion": { - "description": "Country/region.", - "type": "string" - }, - "streetAddress": { - "description": "Street-level address, excluding city, state, countryRegion, and postalCode.", - "type": "string" - } - } - }, - "DocumentModelId": { - "description": "Unique document model name.", - "type": "string", - "pattern": "[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}" - }, - "DocumentModelDescription": { - "description": "Document model description.", - "type": "string", - "maxLength": 4096 - }, - "DocumentBuildMode": { - "description": "Custom document model build mode.", - "type": "string", - "enum": [ - "template", - "neural" - ], - "x-ms-enum": { - "name": "DocumentBuildMode", - "modelAsString": true - } - }, - "DocType": { - "description": "Document type name.", - "type": "string", - "minLength": 2, - "maxLength": 64 - }, - "BoundingPolygon": { - "description": "Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.", - "type": "array", - "items": { - "type": "number", - "minimum": 0 - } - }, - "BoundingRegion": { - "description": "Bounding polygon on a specific page of the input.", - "type": "object", - "required": [ - "pageNumber", - "polygon" - ], - "properties": { - "pageNumber": { - "description": "1-based page number of page containing the bounding region.", - "type": "integer", - "format": "int32", - "minimum": 1 - }, - "polygon": { - "description": "Bounding polygon on the page, or the entire page if not specified.", - "$ref": "#/definitions/BoundingPolygon" - } - } - }, - "Confidence": { - "description": "Prediction confidence.", - "type": "number", - "minimum": 0, - "maximum": 1 - }, - "DocumentSpan": { - "description": "Contiguous region of the concatenated content property, specified as an offset and length.", - "type": "object", - "required": [ - "offset", - "length" - ], - "properties": { - "offset": { - "description": "Zero-based index of the content represented by the span.", - "type": "integer", - "format": "int32", - "minimum": 0 - }, - "length": { - "description": "Number of characters in the content represented by the span.", - "type": "integer", - "format": "int32", - "minimum": 0 - } - } - }, - "StringIndexType": { - "description": "Method used to compute string offset and length.", - "type": "string", - "enum": [ - "textElements", - "unicodeCodePoint", - "utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true - }, - "default": "textElements" - } - }, - "parameters": { - "Endpoint": { - "name": "endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for\nexample: https://westus2.api.cognitive.microsoft.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "QueryApiVersion": { - "name": "api-version", - "description": "Requested API version.", - "required": true, - "type": "string", - "in": "query", - "enum": [ - "2022-08-31" - ], - "x-ms-enum": { - "name": "ApiVersion", - "modelAsString": true - }, - "x-ms-parameter-location": "client" - }, - "PathDocumentModelId": { - "name": "modelId", - "description": "Unique document model name.", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}", - "in": "path", - "x-ms-parameter-location": "method" - }, - "PathOperationId": { - "name": "operationId", - "description": "Unique operation ID.", - "required": true, - "type": "string", - "in": "path", - "x-ms-parameter-location": "method" - }, - "PathResultId": { - "name": "resultId", - "description": "Analyze operation result ID.", - "required": true, - "type": "string", - "in": "path", - "x-ms-parameter-location": "method" - }, - "QueryPages": { - "name": "pages", - "description": "List of 1-based page numbers to analyze. Ex. \"1-3,5,7-9\"", - "required": false, - "type": "string", - "in": "query", - "pattern": "^(\\d+(-\\d+)?)(,\\s*(\\d+(-\\d+)?))*$", - "x-ms-parameter-location": "method" - }, - "QueryLocale": { - "name": "locale", - "description": "Locale hint for text recognition and document analysis. Value may contain only the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\").", - "required": false, - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "QueryStringIndexType": { - "name": "stringIndexType", - "description": "Method used to compute string offset and length.", - "required": false, - "in": "query", - "type": "string", - "enum": [ - "textElements", - "unicodeCodePoint", - "utf16CodeUnit" - ], - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true - }, - "default": "textElements", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Form Recognizer Client", + "description": "Extracts content, layout, and structured data from documents.", + "version": "2022-08-31" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/formrecognizer", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/documentModels/{modelId}:analyze": { + "post": { + "summary": "Analyze document", + "description": "Analyzes document with document model.", + "operationId": "AnalyzeDocument", + "tags": [ + "Analysis" + ], + "consumes": [ + "application/json", + "application/octet-stream", + "application/pdf", + "image/jpeg", + "image/png", + "image/tiff", + "image/bmp", + "image/heif" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/PathDocumentModelId" + }, + { + "$ref": "#/parameters/QueryPages" + }, + { + "$ref": "#/parameters/QueryLocale" + }, + { + "$ref": "#/parameters/QueryStringIndexType" + }, + { + "$ref": "#/parameters/QueryApiVersion" + }, + { + "name": "analyzeRequest", + "description": "Analyze request parameters.", + "required": false, + "in": "body", + "schema": { + "$ref": "#/definitions/AnalyzeDocumentRequest" + } + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AnalyzeDocument_Url": { + "$ref": "./examples/AnalyzeDocument_Url.json" + }, + "AnalyzeDocument_Base64": { + "$ref": "./examples/AnalyzeDocument_Base64.json" + } + } + } + }, + "/documentModels/{modelId}/analyzeResults/{resultId}": { + "get": { + "summary": "Get analyze result", + "description": "Gets the result of document analysis.", + "operationId": "GetAnalyzeDocumentResult", + "tags": [ + "Analysis" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/PathDocumentModelId" + }, + { + "$ref": "#/parameters/PathResultId" + }, + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AnalyzeResultOperation" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAnalyzeDocumentResult": { + "$ref": "./examples/GetAnalyzeDocumentResult.json" + } + } + } + }, + "/documentModels:build": { + "post": { + "summary": "Build document model", + "description": "Builds a custom document analysis model.", + "operationId": "BuildDocumentModel", + "tags": [ + "Creation" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/QueryApiVersion" + }, + { + "name": "buildRequest", + "description": "Building request parameters.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/BuildDocumentModelRequest" + } + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "Operation result URL." + } + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildDocumentModel": { + "$ref": "./examples/BuildDocumentModel.json" + } + } + } + }, + "/documentModels:compose": { + "post": { + "summary": "Compose document model", + "description": "Creates a new document model from document types of existing document models.", + "operationId": "ComposeDocumentModel", + "tags": [ + "Creation" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/QueryApiVersion" + }, + { + "name": "composeRequest", + "description": "Compose request parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ComposeDocumentModelRequest" + } + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "Operation result URL." + } + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ComposeDocumentModel": { + "$ref": "./examples/ComposeDocumentModel.json" + } + } + } + }, + "/documentModels:authorizeCopy": { + "post": { + "summary": "Generate copy authorization", + "description": "Generates authorization to copy a document model to this location with specified modelId and optional description.", + "operationId": "AuthorizeCopyDocumentModel", + "tags": [ + "Creation" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/QueryApiVersion" + }, + { + "name": "authorizeCopyRequest", + "description": "Authorize copy request parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizeCopyRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CopyAuthorization" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AuthorizeCopyDocumentModel": { + "$ref": "./examples/AuthorizeCopyDocumentModel.json" + } + } + } + }, + "/documentModels/{modelId}:copyTo": { + "post": { + "summary": "Copy document model", + "description": "Copies document model to the target resource, region, and modelId.", + "operationId": "CopyDocumentModelTo", + "tags": [ + "Creation" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/PathDocumentModelId" + }, + { + "$ref": "#/parameters/QueryApiVersion" + }, + { + "name": "copyToRequest", + "description": "Copy to request parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CopyAuthorization" + } + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "Operation result URL." + } + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CopyDocumentModelTo": { + "$ref": "./examples/CopyDocumentModelTo.json" + } + } + } + }, + "/operations": { + "get": { + "summary": "List operations", + "description": "Lists all operations.", + "operationId": "GetOperations", + "tags": [ + "Operation" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GetOperationsResponse" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "GetOperations": { + "$ref": "./examples/GetOperations.json" + } + } + } + }, + "/operations/{operationId}": { + "get": { + "summary": "Get operation", + "description": "Gets operation info.", + "operationId": "GetOperation", + "tags": [ + "Operation" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/PathOperationId" + }, + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationDetails" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetOperation": { + "$ref": "./examples/GetOperation.json" + } + } + } + }, + "/documentModels": { + "get": { + "summary": "List document models", + "description": "List all document models", + "operationId": "GetDocumentModels", + "tags": [ + "Management" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GetDocumentModelsResponse" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "GetDocumentModels": { + "$ref": "./examples/GetDocumentModels.json" + } + } + } + }, + "/documentModels/{modelId}": { + "get": { + "summary": "Get document model", + "description": "Gets detailed document model information.", + "operationId": "GetDocumentModel", + "tags": [ + "Management" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/PathDocumentModelId" + }, + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DocumentModelDetails" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetDocumentModel_Prebuilt": { + "$ref": "./examples/GetDocumentModel_Prebuilt.json" + }, + "GetDocumentModel_Custom": { + "$ref": "./examples/GetDocumentModel_Custom.json" + } + } + }, + "delete": { + "summary": "Delete document model", + "description": "Deletes document model.", + "operationId": "DeleteDocumentModel", + "tags": [ + "Management" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/PathDocumentModelId" + }, + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "204": { + "description": "Deleting document model." + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteDocumentModel": { + "$ref": "./examples/DeleteDocumentModel.json" + } + } + } + }, + "/info": { + "get": { + "summary": "Get resource info", + "description": "Return information about the current resource.", + "operationId": "GetResourceDetails", + "tags": [ + "Management" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/QueryApiVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ResourceDetails" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetResourceDetails": { + "$ref": "./examples/GetResourceDetails.json" + } + } + } + } + }, + "definitions": { + "AnalyzeDocumentRequest": { + "description": "Document analysis parameters.", + "type": "object", + "properties": { + "urlSource": { + "description": "Document URL to analyze", + "$ref": "#/definitions/UrlContentSource" + }, + "base64Source": { + "description": "Base64 encoding of the document to analyze", + "$ref": "#/definitions/Base64ContentSource" + } + } + }, + "BuildDocumentModelRequest": { + "description": "Request body to build a new custom document model.", + "type": "object", + "required": [ + "modelId", + "buildMode" + ], + "properties": { + "modelId": { + "$ref": "#/definitions/DocumentModelId" + }, + "description": { + "$ref": "#/definitions/DocumentModelDescription" + }, + "buildMode": { + "$ref": "#/definitions/DocumentBuildMode" + }, + "azureBlobSource": { + "description": "Azure Blob Storage location containing the training data.", + "$ref": "#/definitions/AzureBlobContentSource" + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ComposeDocumentModelRequest": { + "description": "Request body to create a composed document model from component document models.", + "type": "object", + "required": [ + "modelId", + "componentModels" + ], + "properties": { + "modelId": { + "$ref": "#/definitions/DocumentModelId" + }, + "description": { + "$ref": "#/definitions/DocumentModelDescription" + }, + "componentModels": { + "description": "List of component document models to compose.", + "type": "array", + "uniqueItems": true, + "items": { + "$ref": "#/definitions/ComponentDocumentModelDetails" + } + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ComponentDocumentModelDetails": { + "description": "A component of a composed document model.", + "type": "object", + "required": [ + "modelId" + ], + "properties": { + "modelId": { + "$ref": "#/definitions/DocumentModelId" + } + } + }, + "AuthorizeCopyRequest": { + "description": "Request body to authorize document model copy.", + "type": "object", + "required": [ + "modelId" + ], + "properties": { + "modelId": { + "$ref": "#/definitions/DocumentModelId" + }, + "description": { + "$ref": "#/definitions/DocumentModelDescription" + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GetOperationsResponse": { + "description": "List Operations response object.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "description": "List of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationSummary" + } + }, + "nextLink": { + "description": "Link to the next page of operations.", + "type": "string" + } + } + }, + "OperationDetails": { + "description": "Get Operation response object.", + "type": "object", + "discriminator": "kind", + "required": [ + "operationId", + "status", + "createdDateTime", + "lastUpdatedDateTime", + "kind", + "resourceLocation" + ], + "properties": { + "operationId": { + "description": "Operation ID", + "type": "string" + }, + "status": { + "description": "Operation status.", + "type": "string", + "enum": [ + "notStarted", + "running", + "failed", + "succeeded", + "canceled" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "percentCompleted": { + "description": "Operation progress (0-100).", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100 + }, + "createdDateTime": { + "description": "Date and time (UTC) when the operation was created.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedDateTime": { + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "format": "date-time" + }, + "kind": { + "description": "Type of operation.", + "type": "string" + }, + "resourceLocation": { + "description": "URL of the resource targeted by this operation.", + "type": "string" + }, + "apiVersion": { + "description": "API version used to create this operation.", + "type": "string" + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "error": { + "description": "Encountered error.", + "$ref": "#/definitions/Error" + } + } + }, + "DocumentModelBuildOperationDetails": { + "description": "Get Operation response object.", + "x-ms-discriminator-value": "documentModelBuild", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationDetails" + } + ], + "properties": { + "result": { + "description": "Operation result upon success.", + "$ref": "#/definitions/DocumentModelDetails" + } + } + }, + "DocumentModelComposeOperationDetails": { + "description": "Get Operation response object.", + "x-ms-discriminator-value": "documentModelCompose", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationDetails" + } + ], + "properties": { + "result": { + "description": "Operation result upon success.", + "$ref": "#/definitions/DocumentModelDetails" + } + } + }, + "DocumentModelCopyToOperationDetails": { + "description": "Get Operation response object.", + "x-ms-discriminator-value": "documentModelCopyTo", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationDetails" + } + ], + "properties": { + "result": { + "description": "Operation result upon success.", + "$ref": "#/definitions/DocumentModelDetails" + } + } + }, + "GetDocumentModelsResponse": { + "description": "List document models response object.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "description": "List of document models.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentModelSummary" + } + }, + "nextLink": { + "description": "Link to the next page of document models.", + "type": "string" + } + } + }, + "ResourceDetails": { + "description": "General information regarding the current resource.", + "type": "object", + "required": [ + "customDocumentModels" + ], + "properties": { + "customDocumentModels": { + "$ref": "#/definitions/CustomDocumentModelsDetails" + } + } + }, + "CustomDocumentModelsDetails": { + "description": "Details regarding custom document models.", + "type": "object", + "required": [ + "count", + "limit" + ], + "properties": { + "count": { + "description": "Number of custom document models in the current resource.", + "type": "integer", + "format": "int32" + }, + "limit": { + "description": "Maximum number of custom document models supported in the current resource.", + "type": "integer", + "format": "int32" + } + } + }, + "ApiVersion": { + "description": "API version.", + "type": "string", + "enum": [ + "2022-08-31" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + } + }, + "ErrorResponse": { + "description": "Error response object.", + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "Error": { + "description": "Error info.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Target of the error.", + "type": "string" + }, + "details": { + "description": "List of detailed errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerError": { + "description": "Detailed error.", + "type": "object", + "required": [ + "code" + ], + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "UrlContentSource": { + "description": "Content at specified URL.", + "type": "string", + "format": "uri" + }, + "Base64ContentSource": { + "description": "Content represented via Base64 encoding.", + "type": "string", + "format": "byte" + }, + "AzureBlobContentSource": { + "description": "Azure Blob Storage content.", + "type": "object", + "required": [ + "containerUrl" + ], + "properties": { + "containerUrl": { + "description": "Azure Blob Storage container URL.", + "type": "string", + "format": "uri" + }, + "prefix": { + "description": "Blob name prefix.", + "type": "string" + } + } + }, + "CopyAuthorization": { + "description": "Authorization to copy a document model to the specified target resource and modelId.", + "type": "object", + "required": [ + "targetResourceId", + "targetResourceRegion", + "targetModelId", + "targetModelLocation", + "accessToken", + "expirationDateTime" + ], + "properties": { + "targetResourceId": { + "description": "ID of the target Azure resource where the document model should be copied to.", + "type": "string", + "x-ms-azure-resource": true + }, + "targetResourceRegion": { + "description": "Location of the target Azure resource where the document model should be copied to.", + "type": "string" + }, + "targetModelId": { + "description": "Identifier of the target document model.", + "$ref": "#/definitions/DocumentModelId" + }, + "targetModelLocation": { + "description": "URL of the copied document model in the target account.", + "type": "string" + }, + "accessToken": { + "description": "Token used to authorize the request.", + "type": "string" + }, + "expirationDateTime": { + "description": "Date/time when the access token expires.", + "type": "string", + "format": "date-time" + } + } + }, + "OperationSummary": { + "description": "Operation info.", + "type": "object", + "required": [ + "operationId", + "status", + "createdDateTime", + "lastUpdatedDateTime", + "kind", + "resourceLocation" + ], + "properties": { + "operationId": { + "description": "Operation ID", + "type": "string" + }, + "status": { + "description": "Operation status.", + "type": "string", + "enum": [ + "notStarted", + "running", + "failed", + "succeeded", + "canceled" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "percentCompleted": { + "description": "Operation progress (0-100).", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100 + }, + "createdDateTime": { + "description": "Date and time (UTC) when the operation was created.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedDateTime": { + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "format": "date-time" + }, + "kind": { + "description": "Type of operation.", + "type": "string", + "enum": [ + "documentModelBuild", + "documentModelCompose", + "documentModelCopyTo" + ], + "x-ms-enum": { + "name": "OperationKind", + "modelAsString": true + } + }, + "resourceLocation": { + "description": "URL of the resource targeted by this operation.", + "type": "string" + }, + "apiVersion": { + "description": "API version used to create this operation.", + "type": "string" + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DocumentModelSummary": { + "description": "Document model summary.", + "type": "object", + "required": [ + "modelId", + "createdDateTime" + ], + "properties": { + "modelId": { + "$ref": "#/definitions/DocumentModelId" + }, + "description": { + "$ref": "#/definitions/DocumentModelDescription" + }, + "createdDateTime": { + "description": "Date and time (UTC) when the document model was created.", + "type": "string", + "format": "date-time" + }, + "apiVersion": { + "description": "API version used to create this document model.", + "type": "string" + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DocumentModelDetails": { + "description": "Document model info.", + "type": "object", + "required": [ + "modelId", + "createdDateTime" + ], + "properties": { + "modelId": { + "$ref": "#/definitions/DocumentModelId" + }, + "description": { + "$ref": "#/definitions/DocumentModelDescription" + }, + "createdDateTime": { + "description": "Date and time (UTC) when the document model was created.", + "type": "string", + "format": "date-time" + }, + "apiVersion": { + "description": "API version used to create this document model.", + "type": "string" + }, + "tags": { + "description": "List of key-value tag attributes associated with the document model.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "docTypes": { + "description": "Supported document types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DocumentTypeDetails" + } + } + } + }, + "DocumentTypeDetails": { + "description": "Document type info.", + "type": "object", + "required": [ + "fieldSchema" + ], + "properties": { + "description": { + "$ref": "#/definitions/DocumentModelDescription" + }, + "buildMode": { + "$ref": "#/definitions/DocumentBuildMode" + }, + "fieldSchema": { + "$ref": "#/definitions/DocTypeSchema" + }, + "fieldConfidence": { + "description": "Estimated confidence for each field.", + "type": "object", + "additionalProperties": { + "type": "number", + "minimum": 0, + "maximum": 1 + } + } + } + }, + "DocTypeSchema": { + "description": "Description of the document semantic schema using a JSON Schema style syntax.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DocumentFieldSchema" + } + }, + "DocumentFieldSchema": { + "description": "Description of the field semantic schema using a JSON Schema style syntax.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/definitions/DocumentFieldType" + }, + "description": { + "description": "Field description.", + "type": "string" + }, + "example": { + "description": "Example field content.", + "type": "string" + }, + "items": { + "description": "Field type schema of each array element.", + "$ref": "#/definitions/DocumentFieldSchema" + }, + "properties": { + "description": "Named sub-fields of the object field.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DocumentFieldSchema" + } + } + } + }, + "AnalyzeResultOperation": { + "description": "Status and result of the analyze operation.", + "type": "object", + "required": [ + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "status": { + "description": "Operation status.", + "type": "string", + "enum": [ + "notStarted", + "running", + "failed", + "succeeded" + ], + "x-ms-enum": { + "name": "AnalyzeResultOperationStatus", + "modelAsString": false + } + }, + "createdDateTime": { + "description": "Date and time (UTC) when the analyze operation was submitted.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedDateTime": { + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "Encountered error during document analysis.", + "$ref": "#/definitions/Error" + }, + "analyzeResult": { + "$ref": "#/definitions/AnalyzeResult" + } + } + }, + "AnalyzeResult": { + "description": "Document analysis result.", + "type": "object", + "required": [ + "apiVersion", + "modelId", + "stringIndexType", + "content", + "pages" + ], + "properties": { + "apiVersion": { + "description": "API version used to produce this result.", + "$ref": "#/definitions/ApiVersion" + }, + "modelId": { + "description": "Document model ID used to produce this result.", + "$ref": "#/definitions/DocumentModelId" + }, + "stringIndexType": { + "description": "Method used to compute string offset and length.", + "$ref": "#/definitions/StringIndexType" + }, + "content": { + "description": "Concatenate string representation of all textual and visual elements in reading order.", + "type": "string" + }, + "pages": { + "description": "Analyzed pages.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentPage" + } + }, + "paragraphs": { + "description": "Extracted paragraphs.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentParagraph" + } + }, + "tables": { + "description": "Extracted tables.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentTable" + } + }, + "keyValuePairs": { + "description": "Extracted key-value pairs.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentKeyValuePair" + } + }, + "styles": { + "description": "Extracted font styles.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentStyle" + } + }, + "languages": { + "description": "Detected languages.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentLanguage" + } + }, + "documents": { + "description": "Extracted documents.", + "type": "array", + "items": { + "$ref": "#/definitions/Document" + } + } + } + }, + "DocumentPage": { + "description": "Content and layout elements extracted from a page from the input.", + "type": "object", + "required": [ + "pageNumber", + "spans" + ], + "properties": { + "pageNumber": { + "description": "1-based page number in the input document.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "angle": { + "description": "The general orientation of the content in clockwise direction, measured in degrees between (-180, 180].", + "type": "number", + "minimum": -180, + "maximum": 180, + "exclusiveMinimum": true + }, + "width": { + "description": "The width of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0 + }, + "height": { + "description": "The height of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0 + }, + "unit": { + "description": "The unit used by the width, height, and polygon properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\".", + "type": "string", + "enum": [ + "pixel", + "inch" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true + } + }, + "spans": { + "description": "Location of the page in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + }, + "words": { + "description": "Extracted words from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentWord" + } + }, + "selectionMarks": { + "description": "Extracted selection marks from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSelectionMark" + } + }, + "lines": { + "description": "Extracted lines from the page, potentially containing both textual and visual elements.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentLine" + } + } + } + }, + "DocumentWord": { + "description": "A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.", + "type": "object", + "required": [ + "content", + "span", + "confidence" + ], + "properties": { + "content": { + "description": "Text content of the word.", + "type": "string" + }, + "polygon": { + "description": "Bounding polygon of the word.", + "$ref": "#/definitions/BoundingPolygon" + }, + "span": { + "description": "Location of the word in the reading order concatenated content.", + "$ref": "#/definitions/DocumentSpan" + }, + "confidence": { + "description": "Confidence of correctly extracting the word.", + "$ref": "#/definitions/Confidence" + } + } + }, + "DocumentSelectionMark": { + "description": "A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.", + "type": "object", + "required": [ + "state", + "span", + "confidence" + ], + "properties": { + "state": { + "description": "State of the selection mark.", + "$ref": "#/definitions/DocumentSelectionMarkState" + }, + "polygon": { + "description": "Bounding polygon of the selection mark.", + "$ref": "#/definitions/BoundingPolygon" + }, + "span": { + "description": "Location of the selection mark in the reading order concatenated content.", + "$ref": "#/definitions/DocumentSpan" + }, + "confidence": { + "description": "Confidence of correctly extracting the selection mark.", + "$ref": "#/definitions/Confidence" + } + } + }, + "DocumentSelectionMarkState": { + "description": "State of the selection mark.", + "type": "string", + "enum": [ + "selected", + "unselected" + ], + "x-ms-enum": { + "name": "SelectionMarkState", + "modelAsString": true + } + }, + "DocumentLine": { + "description": "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.", + "type": "object", + "required": [ + "content", + "spans" + ], + "properties": { + "content": { + "description": "Concatenated content of the contained elements in reading order.", + "type": "string" + }, + "polygon": { + "description": "Bounding polygon of the line.", + "$ref": "#/definitions/BoundingPolygon" + }, + "spans": { + "description": "Location of the line in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + } + } + }, + "DocumentParagraph": { + "description": "A paragraph object consisting with contiguous lines generally with common alignment and spacing.", + "type": "object", + "required": [ + "content", + "spans" + ], + "properties": { + "role": { + "description": "Semantic role of the paragraph.", + "type": "string", + "enum": [ + "pageHeader", + "pageFooter", + "pageNumber", + "title", + "sectionHeading", + "footnote" + ], + "x-ms-enum": { + "name": "ParagraphRole", + "modelAsString": true + } + }, + "content": { + "description": "Concatenated content of the paragraph in reading order.", + "type": "string" + }, + "boundingRegions": { + "description": "Bounding regions covering the paragraph.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundingRegion" + } + }, + "spans": { + "description": "Location of the paragraph in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + } + } + }, + "DocumentTable": { + "description": "A table object consisting table cells arranged in a rectangular layout.", + "type": "object", + "required": [ + "rowCount", + "columnCount", + "cells", + "spans" + ], + "properties": { + "rowCount": { + "description": "Number of rows in the table.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "columnCount": { + "description": "Number of columns in the table.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "cells": { + "description": "Cells contained within the table.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentTableCell" + } + }, + "boundingRegions": { + "description": "Bounding regions covering the table.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundingRegion" + } + }, + "spans": { + "description": "Location of the table in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + } + } + }, + "DocumentTableCell": { + "description": "An object representing the location and content of a table cell.", + "type": "object", + "required": [ + "rowIndex", + "columnIndex", + "content", + "spans" + ], + "properties": { + "kind": { + "description": "Table cell kind.", + "type": "string", + "enum": [ + "content", + "rowHeader", + "columnHeader", + "stubHead", + "description" + ], + "default": "content", + "x-ms-enum": { + "name": "DocumentTableCellKind", + "modelAsString": true + } + }, + "rowIndex": { + "description": "Row index of the cell.", + "type": "integer", + "format": "int32" + }, + "columnIndex": { + "description": "Column index of the cell.", + "type": "integer", + "format": "int32" + }, + "rowSpan": { + "description": "Number of rows spanned by this cell.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 1 + }, + "columnSpan": { + "description": "Number of columns spanned by this cell.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 1 + }, + "content": { + "description": "Concatenated content of the table cell in reading order.", + "type": "string" + }, + "boundingRegions": { + "description": "Bounding regions covering the table cell.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundingRegion" + } + }, + "spans": { + "description": "Location of the table cell in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + } + } + }, + "DocumentKeyValuePair": { + "description": "An object representing a form field with distinct field label (key) and field value (may be empty).", + "type": "object", + "required": [ + "key", + "confidence" + ], + "properties": { + "key": { + "description": "Field label of the key-value pair.", + "$ref": "#/definitions/DocumentKeyValueElement" + }, + "value": { + "description": "Field value of the key-value pair.", + "$ref": "#/definitions/DocumentKeyValueElement" + }, + "confidence": { + "description": "Confidence of correctly extracting the key-value pair.", + "$ref": "#/definitions/Confidence" + } + } + }, + "DocumentKeyValueElement": { + "description": "An object representing the field key or value in a key-value pair.", + "type": "object", + "required": [ + "content", + "spans" + ], + "properties": { + "content": { + "description": "Concatenated content of the key-value element in reading order.", + "type": "string" + }, + "boundingRegions": { + "description": "Bounding regions covering the key-value element.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundingRegion" + } + }, + "spans": { + "description": "Location of the key-value element in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + } + } + }, + "DocumentStyle": { + "description": "An object representing observed text styles.", + "type": "object", + "required": [ + "spans", + "confidence" + ], + "properties": { + "isHandwritten": { + "description": "Is content handwritten?", + "type": "boolean" + }, + "spans": { + "description": "Location of the text elements in the concatenated content the style applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + }, + "confidence": { + "description": "Confidence of correctly identifying the style.", + "$ref": "#/definitions/Confidence" + } + } + }, + "DocumentLanguage": { + "description": "An object representing the detected language for a given text span.", + "type": "object", + "required": [ + "locale", + "spans", + "confidence" + ], + "properties": { + "locale": { + "description": "Detected language. Value may an ISO 639-1 language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"zh-Hans\").", + "type": "string" + }, + "spans": { + "description": "Location of the text elements in the concatenated content the language applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + }, + "confidence": { + "description": "Confidence of correctly identifying the language.", + "$ref": "#/definitions/Confidence" + } + } + }, + "Document": { + "description": "An object describing the location and semantic content of a document.", + "type": "object", + "required": [ + "docType", + "spans", + "confidence" + ], + "properties": { + "docType": { + "description": "Document type.", + "$ref": "#/definitions/DocType" + }, + "boundingRegions": { + "description": "Bounding regions covering the document.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundingRegion" + } + }, + "spans": { + "description": "Location of the document in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + }, + "fields": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DocumentField" + } + }, + "confidence": { + "description": "Confidence of correctly extracting the document.", + "$ref": "#/definitions/Confidence" + } + } + }, + "DocumentField": { + "description": "An object representing the content and location of a field value.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Data type of the field value.", + "$ref": "#/definitions/DocumentFieldType" + }, + "valueString": { + "description": "String value.", + "type": "string" + }, + "valueDate": { + "description": "Date value in YYYY-MM-DD format (ISO 8601).", + "type": "string", + "format": "date" + }, + "valueTime": { + "description": "Time value in hh:mm:ss format (ISO 8601).", + "type": "string", + "format": "time" + }, + "valuePhoneNumber": { + "description": "Phone number value in E.164 format (ex. +19876543210).", + "type": "string" + }, + "valueNumber": { + "description": "Floating point value.", + "type": "number" + }, + "valueInteger": { + "description": "Integer value.", + "type": "integer", + "format": "int64" + }, + "valueSelectionMark": { + "description": "Selection mark value.", + "$ref": "#/definitions/DocumentSelectionMarkState" + }, + "valueSignature": { + "description": "Presence of signature.", + "type": "string", + "enum": [ + "signed", + "unsigned" + ], + "x-ms-enum": { + "name": "DocumentSignatureType", + "modelAsString": true + } + }, + "valueCountryRegion": { + "description": "3-letter country code value (ISO 3166-1 alpha-3).", + "type": "string" + }, + "valueArray": { + "description": "Array of field values.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentField" + } + }, + "valueObject": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DocumentField" + } + }, + "valueCurrency": { + "description": "Currency value.", + "$ref": "#/definitions/CurrencyValue" + }, + "valueAddress": { + "description": "Address value.", + "$ref": "#/definitions/AddressValue" + }, + "content": { + "description": "Field content.", + "type": "string" + }, + "boundingRegions": { + "description": "Bounding regions covering the field.", + "type": "array", + "items": { + "$ref": "#/definitions/BoundingRegion" + } + }, + "spans": { + "description": "Location of the field in the reading order concatenated content.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentSpan" + } + }, + "confidence": { + "description": "Confidence of correctly extracting the field.", + "$ref": "#/definitions/Confidence" + } + } + }, + "DocumentFieldType": { + "description": "Semantic data type of the field value.", + "type": "string", + "enum": [ + "string", + "date", + "time", + "phoneNumber", + "number", + "integer", + "selectionMark", + "countryRegion", + "signature", + "array", + "object", + "currency", + "address" + ], + "x-ms-enum": { + "name": "DocumentFieldType", + "modelAsString": true + } + }, + "CurrencyValue": { + "description": "Currency field value.", + "type": "object", + "required": [ + "amount" + ], + "properties": { + "amount": { + "description": "Currency amount.", + "type": "number", + "format": "double" + }, + "currencySymbol": { + "description": "Currency symbol label, if any.", + "type": "string" + } + } + }, + "AddressValue": { + "description": "Address field value.", + "type": "object", + "properties": { + "houseNumber": { + "description": "House or building number.", + "type": "string" + }, + "poBox": { + "description": "Post office box number.", + "type": "string" + }, + "road": { + "description": "Street name.", + "type": "string" + }, + "city": { + "description": "Name of city, town, village, etc.", + "type": "string" + }, + "state": { + "description": "First-level administrative division.", + "type": "string" + }, + "postalCode": { + "description": "Postal code used for mail sorting.", + "type": "string" + }, + "countryRegion": { + "description": "Country/region.", + "type": "string" + }, + "streetAddress": { + "description": "Street-level address, excluding city, state, countryRegion, and postalCode.", + "type": "string" + } + } + }, + "DocumentModelId": { + "description": "Unique document model name.", + "type": "string", + "pattern": "[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}" + }, + "DocumentModelDescription": { + "description": "Document model description.", + "type": "string", + "maxLength": 4096 + }, + "DocumentBuildMode": { + "description": "Custom document model build mode.", + "type": "string", + "enum": [ + "template", + "neural" + ], + "x-ms-enum": { + "name": "DocumentBuildMode", + "modelAsString": true + } + }, + "DocType": { + "description": "Document type name.", + "type": "string", + "minLength": 2, + "maxLength": 64 + }, + "BoundingPolygon": { + "description": "Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.", + "type": "array", + "items": { + "type": "number", + "minimum": 0 + } + }, + "BoundingRegion": { + "description": "Bounding polygon on a specific page of the input.", + "type": "object", + "required": [ + "pageNumber", + "polygon" + ], + "properties": { + "pageNumber": { + "description": "1-based page number of page containing the bounding region.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "polygon": { + "description": "Bounding polygon on the page, or the entire page if not specified.", + "$ref": "#/definitions/BoundingPolygon" + } + } + }, + "Confidence": { + "description": "Prediction confidence.", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "DocumentSpan": { + "description": "Contiguous region of the concatenated content property, specified as an offset and length.", + "type": "object", + "required": [ + "offset", + "length" + ], + "properties": { + "offset": { + "description": "Zero-based index of the content represented by the span.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "length": { + "description": "Number of characters in the content represented by the span.", + "type": "integer", + "format": "int32", + "minimum": 0 + } + } + }, + "StringIndexType": { + "description": "Method used to compute string offset and length.", + "type": "string", + "enum": [ + "textElements", + "unicodeCodePoint", + "utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true + }, + "default": "textElements" + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for\nexample: https://westus2.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "QueryApiVersion": { + "name": "api-version", + "description": "Requested API version.", + "required": true, + "type": "string", + "in": "query", + "enum": [ + "2022-08-31" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "x-ms-parameter-location": "client" + }, + "PathDocumentModelId": { + "name": "modelId", + "description": "Unique document model name.", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}", + "in": "path", + "x-ms-parameter-location": "method" + }, + "PathOperationId": { + "name": "operationId", + "description": "Unique operation ID.", + "required": true, + "type": "string", + "in": "path", + "x-ms-parameter-location": "method" + }, + "PathResultId": { + "name": "resultId", + "description": "Analyze operation result ID.", + "required": true, + "type": "string", + "in": "path", + "x-ms-parameter-location": "method" + }, + "QueryPages": { + "name": "pages", + "description": "List of 1-based page numbers to analyze. Ex. \"1-3,5,7-9\"", + "required": false, + "type": "string", + "in": "query", + "pattern": "^(\\d+(-\\d+)?)(,\\s*(\\d+(-\\d+)?))*$", + "x-ms-parameter-location": "method" + }, + "QueryLocale": { + "name": "locale", + "description": "Locale hint for text recognition and document analysis. Value may contain only the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\").", + "required": false, + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "QueryStringIndexType": { + "name": "stringIndexType", + "description": "Method used to compute string offset and length.", + "required": false, + "in": "query", + "type": "string", + "enum": [ + "textElements", + "unicodeCodePoint", + "utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true + }, + "default": "textElements", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Base64.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Base64.json index 9f4032ce41cd..aa2417ead468 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Base64.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Base64.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "prebuilt-layout", - "pages": "1-2,4", - "locale": "en-US", - "stringIndexType": "textElements", - "analyzeRequest": { - "base64Source": "{base64EncodedPdf}" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version={apiVersion}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "prebuilt-layout", + "pages": "1-2,4", + "locale": "en-US", + "stringIndexType": "textElements", + "analyzeRequest": { + "base64Source": "{base64EncodedPdf}" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version={apiVersion}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Url.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Url.json index cf5915e79d9e..026e5753980c 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Url.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AnalyzeDocument_Url.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "customModel", - "pages": "1-2,4", - "locale": "en-US", - "stringIndexType": "textElements", - "analyzeRequest": { - "urlSource": "http://host.com/doc.pdf" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version={apiVersion}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "customModel", + "pages": "1-2,4", + "locale": "en-US", + "stringIndexType": "textElements", + "analyzeRequest": { + "urlSource": "http://host.com/doc.pdf" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version={apiVersion}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AuthorizeCopyDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AuthorizeCopyDocumentModel.json index 8108f410fc4f..660c79dd27e1 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AuthorizeCopyDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/AuthorizeCopyDocumentModel.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "authorizeCopyRequest": { - "modelId": "{targetModelId}", - "description": "{targetModelDescription}" - } - }, - "responses": { - "200": { - "body": { - "targetResourceId": "{targetResourceId}", - "targetResourceRegion": "{targetResourceRegion}", - "targetModelId": "{targetModelId}", - "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/{targetModelId}?api-version={apiVersion}", - "accessToken": "{accessToken}", - "expirationDateTime": "2021-09-23T09:12:54.552Z" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "authorizeCopyRequest": { + "modelId": "{targetModelId}", + "description": "{targetModelDescription}" + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "{targetResourceId}", + "targetResourceRegion": "{targetResourceRegion}", + "targetModelId": "{targetModelId}", + "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/{targetModelId}?api-version={apiVersion}", + "accessToken": "{accessToken}", + "expirationDateTime": "2021-09-23T09:12:54.552Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/BuildDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/BuildDocumentModel.json index eb7df0221a39..60f6db4ac355 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/BuildDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/BuildDocumentModel.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "buildRequest": { - "modelId": "{modelId}", - "description": "{modelDescription}", - "buildMode": "template", - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "{blobNamePrefix}" - }, - "tags": { - "createdBy": "{userId}" - } - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "buildRequest": { + "modelId": "{modelId}", + "description": "{modelDescription}", + "buildMode": "template", + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "{blobNamePrefix}" + }, + "tags": { + "createdBy": "{userId}" + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/ComposeDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/ComposeDocumentModel.json index 5cf1165da148..b59559fdb6b5 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/ComposeDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/ComposeDocumentModel.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "composeRequest": { - "modelId": "{composedModelId}", - "description": "{composedModelDescription}", - "componentModels": [ - { - "modelId": "{modelId1}" - }, - { - "modelId": "{modelId2}" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "composeRequest": { + "modelId": "{composedModelId}", + "description": "{composedModelDescription}", + "componentModels": [ + { + "modelId": "{modelId1}" + }, + { + "modelId": "{modelId2}" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/CopyDocumentModelTo.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/CopyDocumentModelTo.json index 1151bf29bc32..6c55bc8d1939 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/CopyDocumentModelTo.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/CopyDocumentModelTo.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "sourceModel", - "copyToRequest": { - "targetResourceId": "{targetResourceId}", - "targetResourceRegion": "{targetResourceRegion}", - "targetModelId": "targetModel", - "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/targetModel?api-version={apiVersion}", - "accessToken": "{accessToken}", - "expirationDateTime": "2021-09-23T09:12:54.552Z" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "sourceModel", + "copyToRequest": { + "targetResourceId": "{targetResourceId}", + "targetResourceRegion": "{targetResourceRegion}", + "targetModelId": "targetModel", + "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/targetModel?api-version={apiVersion}", + "accessToken": "{accessToken}", + "expirationDateTime": "2021-09-23T09:12:54.552Z" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/operations/{operationId}?api-version={apiVersion}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/DeleteDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/DeleteDocumentModel.json index 5b856e0a7ed7..5b86b604dbf9 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/DeleteDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/DeleteDocumentModel.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "{modelId}" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "{modelId}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetAnalyzeDocumentResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetAnalyzeDocumentResult.json index 2295fa64a3f3..428019fd08e2 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetAnalyzeDocumentResult.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetAnalyzeDocumentResult.json @@ -1,7219 +1,7219 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "prebuilt-invoice", - "resultId": "{resultId}" - }, - "responses": { - "200": { - "body": { - "status": "succeeded", - "createdDateTime": "2021-09-24T13:00:46Z", - "lastUpdatedDateTime": "2021-09-24T13:00:49Z", - "analyzeResult": { - "apiVersion": "{apiVersion}", - "modelId": "prebuilt-invoice", - "stringIndexType": "textElements", - "content": "CONTOSO LTD.\nINVOICE\nContoso Headquarters\nINVOICE: INV-100\n123 456th St\nINVOICE DATE: 11/15/2019\nNew York, NY, 10001\nDUE DATE: 12/15/2019\nCUSTOMER NAME: MICROSOFT CORPORATION\nSERVICE PERIOD: 10/14/2019 – 11/14/2019\nCUSTOMER ID: CID-12345\nMicrosoft Corp\n123 Other St,\nRedmond WA, 98052\nBILL TO:\nSHIP TO:\nSERVICE ADDRESS:\nMicrosoft Finance\nMicrosoft Delivery\nMicrosoft Services\n123 Bill St,\n123 Ship St,\n123 Service St,\nRedmond WA, 98052\nRedmond WA, 98052\nRedmond WA, 98052\nSALESPERSON\nP.O. NUMBER\nREQUISITIONER\nSHIPPED VIA\nF.O.B. POINT\nTERMS\nPO-3333\nDATE\nITEM CODE\nDESCRIPTION\nQTY\nUM\nPRICE\nTAX\nAMOUNT\n3/4/2021\nA123\nConsulting Services\n2\nhours\n$30.00\n10%\n$60.00\n3/5/2021\nB456\nDocument Fee\n3\n$10.00\n5%\n$30.00\n3/6/2021\nC789\nPrinting Fee\n10\npages\n$1.00\n20%\n$10.00\nSUBTOTAL\n$100.00\nSALES TAX\n$10.00\nTOTAL\n$110.00\nPREVIOUS UNPAID BALANCE\n$500.00\nAMOUNT DUE\n$610.00\nTHANK YOU FOR YOUR BUSINESS!\nREMIT TO:\nContoso Billing\n123 Remit St\nNew York, NY, 10001\n:unselected:", - "pages": [ - { - "pageNumber": 1, - "angle": 0, - "width": 8.5, - "height": 11, - "unit": "inch", - "words": [ - { - "content": "CONTOSO", - "polygon": [ - 0.5911, - 0.6857, - 1.7451, - 0.6857, - 1.7451, - 0.8664, - 0.5911, - 0.8664 - ], - "confidence": 1, - "span": { - "offset": 0, - "length": 7 - } - }, - { - "content": "LTD.", - "polygon": [ - 1.8441, - 0.6879, - 2.3181, - 0.6879, - 2.3181, - 0.865, - 1.8441, - 0.865 - ], - "confidence": 1, - "span": { - "offset": 8, - "length": 4 - } - }, - { - "content": "INVOICE", - "polygon": [ - 7.0751, - 0.589, - 7.9886, - 0.589, - 7.9886, - 0.7697, - 7.0751, - 0.7697 - ], - "confidence": 1, - "span": { - "offset": 13, - "length": 7 - } - }, - { - "content": "Contoso", - "polygon": [ - 0.5882, - 1.4303, - 1.1337, - 1.4303, - 1.1337, - 1.5383, - 0.5882, - 1.5383 - ], - "confidence": 1, - "span": { - "offset": 21, - "length": 7 - } - }, - { - "content": "Headquarters", - "polygon": [ - 1.1905, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 1.1905, - 1.5664 - ], - "confidence": 1, - "span": { - "offset": 29, - "length": 12 - } - }, - { - "content": "INVOICE:", - "polygon": [ - 6.8599, - 1.4217, - 7.4328, - 1.4217, - 7.4328, - 1.5218, - 6.8599, - 1.5218 - ], - "confidence": 1, - "span": { - "offset": 42, - "length": 8 - } - }, - { - "content": "INV-100", - "polygon": [ - 7.4959, - 1.422, - 7.9988, - 1.422, - 7.9988, - 1.5215, - 7.4959, - 1.5215 - ], - "confidence": 1, - "span": { - "offset": 51, - "length": 7 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 1.6339, - 0.8213, - 1.6339, - 0.8213, - 1.742, - 0.5945, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 59, - "length": 3 - } - }, - { - "content": "456th", - "polygon": [ - 0.874, - 1.6092, - 1.2102, - 1.6092, - 1.2102, - 1.742, - 0.874, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 63, - "length": 5 - } - }, - { - "content": "St", - "polygon": [ - 1.2598, - 1.6339, - 1.3812, - 1.6339, - 1.3812, - 1.742, - 1.2598, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 69, - "length": 2 - } - }, - { - "content": "INVOICE", - "polygon": [ - 6.2263, - 1.6254, - 6.7562, - 1.6254, - 6.7562, - 1.7256, - 6.2263, - 1.7256 - ], - "confidence": 1, - "span": { - "offset": 72, - "length": 7 - } - }, - { - "content": "DATE:", - "polygon": [ - 6.8132, - 1.6267, - 7.1891, - 1.6267, - 7.1891, - 1.7248, - 6.8132, - 1.7248 - ], - "confidence": 1, - "span": { - "offset": 80, - "length": 5 - } - }, - { - "content": "11/15/2019", - "polygon": [ - 7.2528, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 7.2528, - 1.7449 - ], - "confidence": 1, - "span": { - "offset": 86, - "length": 10 - } - }, - { - "content": "New", - "polygon": [ - 0.5943, - 1.8385, - 0.8848, - 1.8385, - 0.8848, - 1.9454, - 0.5943, - 1.9454 - ], - "confidence": 1, - "span": { - "offset": 97, - "length": 3 - } - }, - { - "content": "York,", - "polygon": [ - 0.9293, - 1.8307, - 1.2568, - 1.8307, - 1.2568, - 1.9675, - 0.9293, - 1.9675 - ], - "confidence": 1, - "span": { - "offset": 101, - "length": 5 - } - }, - { - "content": "NY,", - "polygon": [ - 1.3205, - 1.8382, - 1.5242, - 1.8382, - 1.5242, - 1.9675, - 1.3205, - 1.9675 - ], - "confidence": 1, - "span": { - "offset": 107, - "length": 3 - } - }, - { - "content": "10001", - "polygon": [ - 1.5915, - 1.8372, - 1.9894, - 1.8372, - 1.9894, - 1.9454, - 1.5915, - 1.9454 - ], - "confidence": 1, - "span": { - "offset": 111, - "length": 5 - } - }, - { - "content": "DUE", - "polygon": [ - 6.4966, - 1.8333, - 6.7569, - 1.8333, - 6.7569, - 1.9322, - 6.4966, - 1.9322 - ], - "confidence": 1, - "span": { - "offset": 117, - "length": 3 - } - }, - { - "content": "DATE:", - "polygon": [ - 6.8126, - 1.8333, - 7.1846, - 1.8333, - 7.1846, - 1.9315, - 6.8126, - 1.9315 - ], - "confidence": 1, - "span": { - "offset": 121, - "length": 5 - } - }, - { - "content": "12/15/2019", - "polygon": [ - 7.2494, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 7.2494, - 1.9515 - ], - "confidence": 1, - "span": { - "offset": 127, - "length": 10 - } - }, - { - "content": "CUSTOMER", - "polygon": [ - 4.9513, - 2.0388, - 5.6868, - 2.0388, - 5.6868, - 2.1389, - 4.9513, - 2.1389 - ], - "confidence": 1, - "span": { - "offset": 138, - "length": 8 - } - }, - { - "content": "NAME:", - "polygon": [ - 5.7412, - 2.04, - 6.1764, - 2.04, - 6.1764, - 2.1381, - 5.7412, - 2.1381 - ], - "confidence": 1, - "span": { - "offset": 147, - "length": 5 - } - }, - { - "content": "MICROSOFT", - "polygon": [ - 6.2419, - 2.0391, - 6.9981, - 2.0391, - 6.9981, - 2.1386, - 6.2419, - 2.1386 - ], - "confidence": 1, - "span": { - "offset": 153, - "length": 9 - } - }, - { - "content": "CORPORATION", - "polygon": [ - 7.0448, - 2.0391, - 7.9825, - 2.0391, - 7.9825, - 2.1386, - 7.0448, - 2.1386 - ], - "confidence": 1, - "span": { - "offset": 163, - "length": 11 - } - }, - { - "content": "SERVICE", - "polygon": [ - 5.1667, - 2.2421, - 5.6923, - 2.2421, - 5.6923, - 2.3422, - 5.1667, - 2.3422 - ], - "confidence": 1, - "span": { - "offset": 175, - "length": 7 - } - }, - { - "content": "PERIOD:", - "polygon": [ - 5.748, - 2.2421, - 6.2721, - 2.2421, - 6.2721, - 2.3422, - 5.748, - 2.3422 - ], - "confidence": 1, - "span": { - "offset": 183, - "length": 7 - } - }, - { - "content": "10/14/2019", - "polygon": [ - 6.3357, - 2.2306, - 7.0749, - 2.2306, - 7.0749, - 2.3615, - 6.3357, - 2.3615 - ], - "confidence": 1, - "span": { - "offset": 191, - "length": 10 - } - }, - { - "content": "–", - "polygon": [ - 7.122, - 2.2922, - 7.1995, - 2.2922, - 7.1995, - 2.3037, - 7.122, - 2.3037 - ], - "confidence": 1, - "span": { - "offset": 202, - "length": 1 - } - }, - { - "content": "11/14/2019", - "polygon": [ - 7.2528, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 7.2528, - 2.3615 - ], - "confidence": 1, - "span": { - "offset": 204, - "length": 10 - } - }, - { - "content": "CUSTOMER", - "polygon": [ - 6.3253, - 2.4488, - 7.0608, - 2.4488, - 7.0608, - 2.5489, - 6.3253, - 2.5489 - ], - "confidence": 1, - "span": { - "offset": 215, - "length": 8 - } - }, - { - "content": "ID:", - "polygon": [ - 7.1153, - 2.45, - 7.2809, - 2.45, - 7.2809, - 2.5481, - 7.1153, - 2.5481 - ], - "confidence": 1, - "span": { - "offset": 224, - "length": 3 - } - }, - { - "content": "CID-12345", - "polygon": [ - 7.3369, - 2.4491, - 7.9951, - 2.4491, - 7.9951, - 2.5486, - 7.3369, - 2.5486 - ], - "confidence": 1, - "span": { - "offset": 228, - "length": 9 - } - }, - { - "content": "Microsoft", - "polygon": [ - 0.5943, - 2.6436, - 1.2303, - 2.6436, - 1.2303, - 2.759, - 0.5943, - 2.759 - ], - "confidence": 1, - "span": { - "offset": 238, - "length": 9 - } - }, - { - "content": "Corp", - "polygon": [ - 1.2808, - 2.651, - 1.586, - 2.651, - 1.586, - 2.7871, - 1.2808, - 2.7871 - ], - "confidence": 1, - "span": { - "offset": 248, - "length": 4 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 2.8541, - 0.8213, - 2.8541, - 0.8213, - 2.9623, - 0.5945, - 2.9623 - ], - "confidence": 1, - "span": { - "offset": 253, - "length": 3 - } - }, - { - "content": "Other", - "polygon": [ - 0.875, - 2.8476, - 1.262, - 2.8476, - 1.262, - 2.9623, - 0.875, - 2.9623 - ], - "confidence": 1, - "span": { - "offset": 257, - "length": 5 - } - }, - { - "content": "St,", - "polygon": [ - 1.3058, - 2.8541, - 1.4633, - 2.8541, - 1.4633, - 2.9845, - 1.3058, - 2.9845 - ], - "confidence": 1, - "span": { - "offset": 263, - "length": 3 - } - }, - { - "content": "Redmond", - "polygon": [ - 0.5943, - 3.0513, - 1.2222, - 3.0513, - 1.2222, - 3.1656, - 0.5943, - 3.1656 - ], - "confidence": 1, - "span": { - "offset": 267, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 1.2753, - 3.0585, - 1.5468, - 3.0585, - 1.5468, - 3.1878, - 1.2753, - 3.1878 - ], - "confidence": 1, - "span": { - "offset": 275, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 1.6033, - 3.0575, - 2.0083, - 3.0575, - 2.0083, - 3.1656, - 1.6033, - 3.1656 - ], - "confidence": 1, - "span": { - "offset": 279, - "length": 5 - } - }, - { - "content": "BILL", - "polygon": [ - 0.5909, - 3.5603, - 0.8438, - 3.5603, - 0.8438, - 3.6579, - 0.5909, - 3.6579 - ], - "confidence": 1, - "span": { - "offset": 285, - "length": 4 - } - }, - { - "content": "TO:", - "polygon": [ - 0.8846, - 3.559, - 1.1032, - 3.559, - 1.1032, - 3.6592, - 0.8846, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 290, - "length": 3 - } - }, - { - "content": "SHIP", - "polygon": [ - 3.3361, - 3.559, - 3.6278, - 3.559, - 3.6278, - 3.6592, - 3.3361, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 294, - "length": 4 - } - }, - { - "content": "TO:", - "polygon": [ - 3.6716, - 3.559, - 3.8903, - 3.559, - 3.8903, - 3.6592, - 3.6716, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 299, - "length": 3 - } - }, - { - "content": "SERVICE", - "polygon": [ - 6.2104, - 3.559, - 6.7361, - 3.559, - 6.7361, - 3.6592, - 6.2104, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 303, - "length": 7 - } - }, - { - "content": "ADDRESS:", - "polygon": [ - 6.7828, - 3.559, - 7.4232, - 3.559, - 7.4232, - 3.6592, - 6.7828, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 311, - "length": 8 - } - }, - { - "content": "Microsoft", - "polygon": [ - 0.5943, - 3.7641, - 1.2303, - 3.7641, - 1.2303, - 3.8794, - 0.5943, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 320, - "length": 9 - } - }, - { - "content": "Finance", - "polygon": [ - 1.287, - 3.7701, - 1.7878, - 3.7701, - 1.7878, - 3.8794, - 1.287, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 330, - "length": 7 - } - }, - { - "content": "Microsoft", - "polygon": [ - 3.3454, - 3.7641, - 3.9814, - 3.7641, - 3.9814, - 3.8794, - 3.3454, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 338, - "length": 9 - } - }, - { - "content": "Delivery", - "polygon": [ - 4.0381, - 3.7647, - 4.5762, - 3.7647, - 4.5762, - 3.9076, - 4.0381, - 3.9076 - ], - "confidence": 1, - "span": { - "offset": 348, - "length": 8 - } - }, - { - "content": "Microsoft", - "polygon": [ - 6.2197, - 3.7641, - 6.8557, - 3.7641, - 6.8557, - 3.8794, - 6.2197, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 357, - "length": 9 - } - }, - { - "content": "Services", - "polygon": [ - 6.9042, - 3.7701, - 7.4427, - 3.7701, - 7.4427, - 3.8794, - 6.9042, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 367, - "length": 8 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 3.9746, - 0.8213, - 3.9746, - 0.8213, - 4.0827, - 0.5945, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 376, - "length": 3 - } - }, - { - "content": "Bill", - "polygon": [ - 0.8842, - 3.9681, - 1.0657, - 3.9681, - 1.0657, - 4.0817, - 0.8842, - 4.0817 - ], - "confidence": 1, - "span": { - "offset": 380, - "length": 4 - } - }, - { - "content": "St,", - "polygon": [ - 1.1222, - 3.9746, - 1.2765, - 3.9746, - 1.2765, - 4.1049, - 1.1222, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 385, - "length": 3 - } - }, - { - "content": "123", - "polygon": [ - 3.3456, - 3.9746, - 3.5724, - 3.9746, - 3.5724, - 4.0827, - 3.3456, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 389, - "length": 3 - } - }, - { - "content": "Ship", - "polygon": [ - 3.6239, - 3.9681, - 3.9042, - 3.9681, - 3.9042, - 4.1109, - 3.6239, - 4.1109 - ], - "confidence": 1, - "span": { - "offset": 393, - "length": 4 - } - }, - { - "content": "St,", - "polygon": [ - 3.9536, - 3.9746, - 4.1111, - 3.9746, - 4.1111, - 4.1049, - 3.9536, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 398, - "length": 3 - } - }, - { - "content": "123", - "polygon": [ - 6.2199, - 3.9746, - 6.4467, - 3.9746, - 6.4467, - 4.0827, - 6.2199, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 402, - "length": 3 - } - }, - { - "content": "Service", - "polygon": [ - 6.4985, - 3.9734, - 6.9738, - 3.9734, - 6.9738, - 4.0827, - 6.4985, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 406, - "length": 7 - } - }, - { - "content": "St,", - "polygon": [ - 7.0246, - 3.9746, - 7.1821, - 3.9746, - 7.1821, - 4.1049, - 7.0246, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 414, - "length": 3 - } - }, - { - "content": "Redmond", - "polygon": [ - 0.5943, - 4.1717, - 1.2222, - 4.1717, - 1.2222, - 4.2861, - 0.5943, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 418, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 1.2753, - 4.1789, - 1.5468, - 4.1789, - 1.5468, - 4.3082, - 1.2753, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 426, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 1.6033, - 4.1779, - 2.0083, - 4.1779, - 2.0083, - 4.2861, - 1.6033, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 430, - "length": 5 - } - }, - { - "content": "Redmond", - "polygon": [ - 3.3454, - 4.1717, - 3.9732, - 4.1717, - 3.9732, - 4.2861, - 3.3454, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 436, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 4.0264, - 4.1789, - 4.2979, - 4.1789, - 4.2979, - 4.3082, - 4.0264, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 444, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 4.3544, - 4.1779, - 4.7594, - 4.1779, - 4.7594, - 4.2861, - 4.3544, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 448, - "length": 5 - } - }, - { - "content": "Redmond", - "polygon": [ - 6.2197, - 4.1717, - 6.8475, - 4.1717, - 6.8475, - 4.2861, - 6.2197, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 454, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 6.9007, - 4.1789, - 7.1722, - 4.1789, - 7.1722, - 4.3082, - 6.9007, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 462, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 7.2287, - 4.1779, - 7.6337, - 4.1779, - 7.6337, - 4.2861, - 7.2287, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 466, - "length": 5 - } - }, - { - "content": "SALESPERSON", - "polygon": [ - 0.7018, - 4.6528, - 1.6092, - 4.6528, - 1.6092, - 4.7529, - 0.7018, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 472, - "length": 11 - } - }, - { - "content": "P.O.", - "polygon": [ - 2.1216, - 4.6528, - 2.3788, - 4.6528, - 2.3788, - 4.7529, - 2.1216, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 484, - "length": 4 - } - }, - { - "content": "NUMBER", - "polygon": [ - 2.4376, - 4.654, - 3.0155, - 4.654, - 3.0155, - 4.7529, - 2.4376, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 489, - "length": 6 - } - }, - { - "content": "REQUISITIONER", - "polygon": [ - 3.4953, - 4.6528, - 4.5157, - 4.6528, - 4.5157, - 4.7687, - 3.4953, - 4.7687 - ], - "confidence": 1, - "span": { - "offset": 496, - "length": 13 - } - }, - { - "content": "SHIPPED", - "polygon": [ - 4.81, - 4.6528, - 5.362, - 4.6528, - 5.362, - 4.7529, - 4.81, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 510, - "length": 7 - } - }, - { - "content": "VIA", - "polygon": [ - 5.409, - 4.654, - 5.6317, - 4.654, - 5.6317, - 4.7517, - 5.409, - 4.7517 - ], - "confidence": 1, - "span": { - "offset": 518, - "length": 3 - } - }, - { - "content": "F.O.B.", - "polygon": [ - 5.8696, - 4.6528, - 6.2467, - 4.6528, - 6.2467, - 4.7529, - 5.8696, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 522, - "length": 6 - } - }, - { - "content": "POINT", - "polygon": [ - 6.3054, - 4.6528, - 6.706, - 4.6528, - 6.706, - 4.7529, - 6.3054, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 529, - "length": 5 - } - }, - { - "content": "TERMS", - "polygon": [ - 7.1806, - 4.6528, - 7.6304, - 4.6528, - 7.6304, - 4.7529, - 7.1806, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 535, - "length": 5 - } - }, - { - "content": "PO-3333", - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ], - "confidence": 1, - "span": { - "offset": 541, - "length": 7 - } - }, - { - "content": "DATE", - "polygon": [ - 0.7409, - 5.421, - 1.0744, - 5.421, - 1.0744, - 5.5186, - 0.7409, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 549, - "length": 4 - } - }, - { - "content": "ITEM", - "polygon": [ - 1.4213, - 5.421, - 1.7338, - 5.421, - 1.7338, - 5.5186, - 1.4213, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 554, - "length": 4 - } - }, - { - "content": "CODE", - "polygon": [ - 1.7893, - 5.4197, - 2.1407, - 5.4197, - 2.1407, - 5.5199, - 1.7893, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 559, - "length": 4 - } - }, - { - "content": "DESCRIPTION", - "polygon": [ - 2.8516, - 5.4197, - 3.7134, - 5.4197, - 3.7134, - 5.5199, - 2.8516, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 564, - "length": 11 - } - }, - { - "content": "QTY", - "polygon": [ - 4.4043, - 5.4197, - 4.6631, - 5.4197, - 4.6631, - 5.5357, - 4.4043, - 5.5357 - ], - "confidence": 1, - "span": { - "offset": 576, - "length": 3 - } - }, - { - "content": "UM", - "polygon": [ - 5.049, - 5.421, - 5.2654, - 5.421, - 5.2654, - 5.5199, - 5.049, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 580, - "length": 2 - } - }, - { - "content": "PRICE", - "polygon": [ - 5.8563, - 5.4199, - 6.2163, - 5.4199, - 6.2163, - 5.5197, - 5.8563, - 5.5197 - ], - "confidence": 1, - "span": { - "offset": 583, - "length": 5 - } - }, - { - "content": "TAX", - "polygon": [ - 6.7169, - 5.421, - 6.974, - 5.421, - 6.974, - 5.5186, - 6.7169, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 589, - "length": 3 - } - }, - { - "content": "AMOUNT", - "polygon": [ - 7.2847, - 5.4197, - 7.9039, - 5.4197, - 7.9039, - 5.5199, - 7.2847, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 593, - "length": 6 - } - }, - { - "content": "3/4/2021", - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ], - "confidence": 1, - "span": { - "offset": 600, - "length": 8 - } - }, - { - "content": "A123", - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 609, - "length": 4 - } - }, - { - "content": "Consulting", - "polygon": [ - 2.3388, - 5.6883, - 3.0438, - 5.6883, - 3.0438, - 5.8312, - 2.3388, - 5.8312 - ], - "confidence": 1, - "span": { - "offset": 614, - "length": 10 - } - }, - { - "content": "Services", - "polygon": [ - 3.0925, - 5.6937, - 3.6278, - 5.6937, - 3.6278, - 5.803, - 3.0925, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 625, - "length": 8 - } - }, - { - "content": "2", - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ], - "confidence": 1, - "span": { - "offset": 634, - "length": 1 - } - }, - { - "content": "hours", - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 636, - "length": 5 - } - }, - { - "content": "$30.00", - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ], - "confidence": 1, - "span": { - "offset": 642, - "length": 6 - } - }, - { - "content": "10%", - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ], - "confidence": 1, - "span": { - "offset": 649, - "length": 3 - } - }, - { - "content": "$60.00", - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ], - "confidence": 1, - "span": { - "offset": 653, - "length": 6 - } - }, - { - "content": "3/5/2021", - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ], - "confidence": 1, - "span": { - "offset": 660, - "length": 8 - } - }, - { - "content": "B456", - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 669, - "length": 4 - } - }, - { - "content": "Document", - "polygon": [ - 2.345, - 5.993, - 3.0318, - 5.993, - 3.0318, - 6.0997, - 2.345, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 674, - "length": 8 - } - }, - { - "content": "Fee", - "polygon": [ - 3.0887, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 3.0887, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 683, - "length": 3 - } - }, - { - "content": "3", - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 687, - "length": 1 - } - }, - { - "content": "$10.00", - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ], - "confidence": 1, - "span": { - "offset": 689, - "length": 6 - } - }, - { - "content": "5%", - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ], - "confidence": 1, - "span": { - "offset": 696, - "length": 2 - } - }, - { - "content": "$30.00", - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ], - "confidence": 1, - "span": { - "offset": 699, - "length": 6 - } - }, - { - "content": "3/6/2021", - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ], - "confidence": 1, - "span": { - "offset": 706, - "length": 8 - } - }, - { - "content": "C789", - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 715, - "length": 4 - } - }, - { - "content": "Printing", - "polygon": [ - 2.345, - 6.2906, - 2.8575, - 6.2906, - 2.8575, - 6.4281, - 2.345, - 6.4281 - ], - "confidence": 1, - "span": { - "offset": 720, - "length": 8 - } - }, - { - "content": "Fee", - "polygon": [ - 2.9143, - 6.2933, - 3.1351, - 6.2933, - 3.1351, - 6.3999, - 2.9143, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 729, - "length": 3 - } - }, - { - "content": "10", - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 733, - "length": 2 - } - }, - { - "content": "pages", - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ], - "confidence": 1, - "span": { - "offset": 736, - "length": 5 - } - }, - { - "content": "$1.00", - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ], - "confidence": 1, - "span": { - "offset": 742, - "length": 5 - } - }, - { - "content": "20%", - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ], - "confidence": 1, - "span": { - "offset": 748, - "length": 3 - } - }, - { - "content": "$10.00", - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ], - "confidence": 1, - "span": { - "offset": 752, - "length": 6 - } - }, - { - "content": "SUBTOTAL", - "polygon": [ - 6.0282, - 6.9118, - 6.7309, - 6.9118, - 6.7309, - 7.0199, - 6.0282, - 7.0199 - ], - "confidence": 1, - "span": { - "offset": 759, - "length": 8 - } - }, - { - "content": "$100.00", - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ], - "confidence": 1, - "span": { - "offset": 768, - "length": 7 - } - }, - { - "content": "SALES", - "polygon": [ - 6.0382, - 7.2089, - 6.4262, - 7.2089, - 6.4262, - 7.317, - 6.0382, - 7.317 - ], - "confidence": 1, - "span": { - "offset": 776, - "length": 5 - } - }, - { - "content": "TAX", - "polygon": [ - 6.4702, - 7.2099, - 6.728, - 7.2099, - 6.728, - 7.316, - 6.4702, - 7.316 - ], - "confidence": 1, - "span": { - "offset": 782, - "length": 3 - } - }, - { - "content": "$10.00", - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ], - "confidence": 1, - "span": { - "offset": 786, - "length": 6 - } - }, - { - "content": "TOTAL", - "polygon": [ - 6.2969, - 7.5089, - 6.7309, - 7.5089, - 6.7309, - 7.617, - 6.2969, - 7.617 - ], - "confidence": 1, - "span": { - "offset": 793, - "length": 5 - } - }, - { - "content": "$110.00", - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ], - "confidence": 1, - "span": { - "offset": 799, - "length": 7 - } - }, - { - "content": "PREVIOUS", - "polygon": [ - 4.8126, - 7.8055, - 5.4789, - 7.8055, - 5.4789, - 7.9137, - 4.8126, - 7.9137 - ], - "confidence": 1, - "span": { - "offset": 807, - "length": 8 - } - }, - { - "content": "UNPAID", - "polygon": [ - 5.5362, - 7.8065, - 6.057, - 7.8065, - 6.057, - 7.9137, - 5.5362, - 7.9137 - ], - "confidence": 1, - "span": { - "offset": 816, - "length": 6 - } - }, - { - "content": "BALANCE", - "polygon": [ - 6.1164, - 7.8057, - 6.7249, - 7.8057, - 6.7249, - 7.9135, - 6.1164, - 7.9135 - ], - "confidence": 1, - "span": { - "offset": 823, - "length": 7 - } - }, - { - "content": "$500.00", - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ], - "confidence": 1, - "span": { - "offset": 831, - "length": 7 - } - }, - { - "content": "AMOUNT", - "polygon": [ - 5.7652, - 8.1022, - 6.4055, - 8.1022, - 6.4055, - 8.2104, - 5.7652, - 8.2104 - ], - "confidence": 1, - "span": { - "offset": 839, - "length": 6 - } - }, - { - "content": "DUE", - "polygon": [ - 6.4562, - 8.1032, - 6.725, - 8.1032, - 6.725, - 8.2104, - 6.4562, - 8.2104 - ], - "confidence": 1, - "span": { - "offset": 846, - "length": 3 - } - }, - { - "content": "$610.00", - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ], - "confidence": 1, - "span": { - "offset": 850, - "length": 7 - } - }, - { - "content": "THANK", - "polygon": [ - 3.129, - 8.5453, - 3.5887, - 8.5453, - 3.5887, - 8.6429, - 3.129, - 8.6429 - ], - "confidence": 1, - "span": { - "offset": 858, - "length": 5 - } - }, - { - "content": "YOU", - "polygon": [ - 3.6316, - 8.544, - 3.9064, - 8.544, - 3.9064, - 8.6442, - 3.6316, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 864, - "length": 3 - } - }, - { - "content": "FOR", - "polygon": [ - 3.9671, - 8.544, - 4.2187, - 8.544, - 4.2187, - 8.6442, - 3.9671, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 868, - "length": 3 - } - }, - { - "content": "YOUR", - "polygon": [ - 4.2638, - 8.544, - 4.6347, - 8.544, - 4.6347, - 8.6442, - 4.2638, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 872, - "length": 4 - } - }, - { - "content": "BUSINESS!", - "polygon": [ - 4.6859, - 8.539, - 5.356, - 8.539, - 5.356, - 8.6442, - 4.6859, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 877, - "length": 9 - } - }, - { - "content": "REMIT", - "polygon": [ - 0.5909, - 9.1619, - 1.0014, - 9.1619, - 1.0014, - 9.2596, - 0.5909, - 9.2596 - ], - "confidence": 1, - "span": { - "offset": 887, - "length": 5 - } - }, - { - "content": "TO:", - "polygon": [ - 1.0446, - 9.1607, - 1.2603, - 9.1607, - 1.2603, - 9.2608, - 1.0446, - 9.2608 - ], - "confidence": 1, - "span": { - "offset": 893, - "length": 3 - } - }, - { - "content": "Contoso", - "polygon": [ - 0.5882, - 9.3697, - 1.1337, - 9.3697, - 1.1337, - 9.4777, - 0.5882, - 9.4777 - ], - "confidence": 1, - "span": { - "offset": 897, - "length": 7 - } - }, - { - "content": "Billing", - "polygon": [ - 1.1905, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 1.1905, - 9.5059 - ], - "confidence": 1, - "span": { - "offset": 905, - "length": 7 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 9.5728, - 0.8213, - 9.5728, - 0.8213, - 9.681, - 0.5945, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 913, - "length": 3 - } - }, - { - "content": "Remit", - "polygon": [ - 0.881, - 9.5717, - 1.264, - 9.5717, - 1.264, - 9.681, - 0.881, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 917, - "length": 5 - } - }, - { - "content": "St", - "polygon": [ - 1.3125, - 9.5728, - 1.4337, - 9.5728, - 1.4337, - 9.681, - 1.3125, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 923, - "length": 2 - } - }, - { - "content": "New", - "polygon": [ - 0.5943, - 9.7808, - 0.8848, - 9.7808, - 0.8848, - 9.8877, - 0.5943, - 9.8877 - ], - "confidence": 1, - "span": { - "offset": 926, - "length": 3 - } - }, - { - "content": "York,", - "polygon": [ - 0.9293, - 9.773, - 1.2568, - 9.773, - 1.2568, - 9.9098, - 0.9293, - 9.9098 - ], - "confidence": 1, - "span": { - "offset": 930, - "length": 5 - } - }, - { - "content": "NY,", - "polygon": [ - 1.3205, - 9.7805, - 1.5233, - 9.7805, - 1.5233, - 9.9098, - 1.3205, - 9.9098 - ], - "confidence": 1, - "span": { - "offset": 936, - "length": 3 - } - }, - { - "content": "10001", - "polygon": [ - 1.5903, - 9.7795, - 1.9882, - 9.7795, - 1.9882, - 9.8877, - 1.5903, - 9.8877 - ], - "confidence": 1, - "span": { - "offset": 940, - "length": 5 - } - } - ], - "selectionMarks": [ - { - "state": "unselected", - "polygon": [ - 4.3231, - 5.6279, - 4.7562, - 5.6279, - 4.7562, - 5.8654, - 4.3231, - 5.8654 - ], - "confidence": 0.212, - "span": { - "offset": 946, - "length": 12 - } - } - ], - "lines": [ - { - "content": "CONTOSO LTD.", - "polygon": [ - 0.5911, - 0.6857, - 2.3181, - 0.6857, - 2.3181, - 0.8664, - 0.5911, - 0.8664 - ], - "spans": [ - { - "offset": 0, - "length": 12 - } - ] - }, - { - "content": "INVOICE", - "polygon": [ - 7.0751, - 0.589, - 7.9886, - 0.589, - 7.9886, - 0.7697, - 7.0751, - 0.7697 - ], - "spans": [ - { - "offset": 13, - "length": 7 - } - ] - }, - { - "content": "Contoso Headquarters", - "polygon": [ - 0.5882, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 0.5882, - 1.5664 - ], - "spans": [ - { - "offset": 21, - "length": 20 - } - ] - }, - { - "content": "INVOICE: INV-100", - "polygon": [ - 6.8599, - 1.4217, - 7.9988, - 1.4217, - 7.9988, - 1.5218, - 6.8599, - 1.5218 - ], - "spans": [ - { - "offset": 42, - "length": 16 - } - ] - }, - { - "content": "123 456th St", - "polygon": [ - 0.5945, - 1.6092, - 1.3812, - 1.6092, - 1.3812, - 1.742, - 0.5945, - 1.742 - ], - "spans": [ - { - "offset": 59, - "length": 12 - } - ] - }, - { - "content": "INVOICE DATE: 11/15/2019", - "polygon": [ - 6.2263, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 6.2263, - 1.7449 - ], - "spans": [ - { - "offset": 72, - "length": 24 - } - ] - }, - { - "content": "New York, NY, 10001", - "polygon": [ - 0.5943, - 1.8307, - 1.9894, - 1.8307, - 1.9894, - 1.9675, - 0.5943, - 1.9675 - ], - "spans": [ - { - "offset": 97, - "length": 19 - } - ] - }, - { - "content": "DUE DATE: 12/15/2019", - "polygon": [ - 6.4966, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 6.4966, - 1.9515 - ], - "spans": [ - { - "offset": 117, - "length": 20 - } - ] - }, - { - "content": "CUSTOMER NAME: MICROSOFT CORPORATION", - "polygon": [ - 4.9513, - 2.0388, - 7.9825, - 2.0388, - 7.9825, - 2.1389, - 4.9513, - 2.1389 - ], - "spans": [ - { - "offset": 138, - "length": 36 - } - ] - }, - { - "content": "SERVICE PERIOD: 10/14/2019 – 11/14/2019", - "polygon": [ - 5.1667, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 5.1667, - 2.3615 - ], - "spans": [ - { - "offset": 175, - "length": 39 - } - ] - }, - { - "content": "CUSTOMER ID: CID-12345", - "polygon": [ - 6.3253, - 2.4488, - 7.9951, - 2.4488, - 7.9951, - 2.5489, - 6.3253, - 2.5489 - ], - "spans": [ - { - "offset": 215, - "length": 22 - } - ] - }, - { - "content": "Microsoft Corp", - "polygon": [ - 0.5943, - 2.6436, - 1.586, - 2.6436, - 1.586, - 2.7871, - 0.5943, - 2.7871 - ], - "spans": [ - { - "offset": 238, - "length": 14 - } - ] - }, - { - "content": "123 Other St,", - "polygon": [ - 0.5945, - 2.8476, - 1.4633, - 2.8476, - 1.4633, - 2.9845, - 0.5945, - 2.9845 - ], - "spans": [ - { - "offset": 253, - "length": 13 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 0.5943, - 3.0513, - 2.0083, - 3.0513, - 2.0083, - 3.1878, - 0.5943, - 3.1878 - ], - "spans": [ - { - "offset": 267, - "length": 17 - } - ] - }, - { - "content": "BILL TO:", - "polygon": [ - 0.5909, - 3.559, - 1.1032, - 3.559, - 1.1032, - 3.6592, - 0.5909, - 3.6592 - ], - "spans": [ - { - "offset": 285, - "length": 8 - } - ] - }, - { - "content": "SHIP TO:", - "polygon": [ - 3.3361, - 3.559, - 3.8903, - 3.559, - 3.8903, - 3.6592, - 3.3361, - 3.6592 - ], - "spans": [ - { - "offset": 294, - "length": 8 - } - ] - }, - { - "content": "SERVICE ADDRESS:", - "polygon": [ - 6.2104, - 3.559, - 7.4232, - 3.559, - 7.4232, - 3.6592, - 6.2104, - 3.6592 - ], - "spans": [ - { - "offset": 303, - "length": 16 - } - ] - }, - { - "content": "Microsoft Finance", - "polygon": [ - 0.5943, - 3.7641, - 1.7878, - 3.7641, - 1.7878, - 3.8794, - 0.5943, - 3.8794 - ], - "spans": [ - { - "offset": 320, - "length": 17 - } - ] - }, - { - "content": "Microsoft Delivery", - "polygon": [ - 3.3454, - 3.7641, - 4.5762, - 3.7641, - 4.5762, - 3.9076, - 3.3454, - 3.9076 - ], - "spans": [ - { - "offset": 338, - "length": 18 - } - ] - }, - { - "content": "Microsoft Services", - "polygon": [ - 6.2197, - 3.7641, - 7.4427, - 3.7641, - 7.4427, - 3.8794, - 6.2197, - 3.8794 - ], - "spans": [ - { - "offset": 357, - "length": 18 - } - ] - }, - { - "content": "123 Bill St,", - "polygon": [ - 0.5945, - 3.9681, - 1.2765, - 3.9681, - 1.2765, - 4.1049, - 0.5945, - 4.1049 - ], - "spans": [ - { - "offset": 376, - "length": 12 - } - ] - }, - { - "content": "123 Ship St,", - "polygon": [ - 3.3456, - 3.9681, - 4.1111, - 3.9681, - 4.1111, - 4.1109, - 3.3456, - 4.1109 - ], - "spans": [ - { - "offset": 389, - "length": 12 - } - ] - }, - { - "content": "123 Service St,", - "polygon": [ - 6.2199, - 3.9734, - 7.1821, - 3.9734, - 7.1821, - 4.1049, - 6.2199, - 4.1049 - ], - "spans": [ - { - "offset": 402, - "length": 15 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 0.5943, - 4.1717, - 2.0083, - 4.1717, - 2.0083, - 4.3082, - 0.5943, - 4.3082 - ], - "spans": [ - { - "offset": 418, - "length": 17 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 3.3454, - 4.1717, - 4.7594, - 4.1717, - 4.7594, - 4.3082, - 3.3454, - 4.3082 - ], - "spans": [ - { - "offset": 436, - "length": 17 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 6.2197, - 4.1717, - 7.6337, - 4.1717, - 7.6337, - 4.3082, - 6.2197, - 4.3082 - ], - "spans": [ - { - "offset": 454, - "length": 17 - } - ] - }, - { - "content": "SALESPERSON", - "polygon": [ - 0.7018, - 4.6528, - 1.6092, - 4.6528, - 1.6092, - 4.7529, - 0.7018, - 4.7529 - ], - "spans": [ - { - "offset": 472, - "length": 11 - } - ] - }, - { - "content": "P.O. NUMBER", - "polygon": [ - 2.1216, - 4.6528, - 3.0155, - 4.6528, - 3.0155, - 4.7529, - 2.1216, - 4.7529 - ], - "spans": [ - { - "offset": 484, - "length": 11 - } - ] - }, - { - "content": "REQUISITIONER", - "polygon": [ - 3.4953, - 4.6528, - 4.5157, - 4.6528, - 4.5157, - 4.7687, - 3.4953, - 4.7687 - ], - "spans": [ - { - "offset": 496, - "length": 13 - } - ] - }, - { - "content": "SHIPPED VIA", - "polygon": [ - 4.81, - 4.6528, - 5.6317, - 4.6528, - 5.6317, - 4.7529, - 4.81, - 4.7529 - ], - "spans": [ - { - "offset": 510, - "length": 11 - } - ] - }, - { - "content": "F.O.B. POINT", - "polygon": [ - 5.8696, - 4.6528, - 6.706, - 4.6528, - 6.706, - 4.7529, - 5.8696, - 4.7529 - ], - "spans": [ - { - "offset": 522, - "length": 12 - } - ] - }, - { - "content": "TERMS", - "polygon": [ - 7.1806, - 4.6528, - 7.6304, - 4.6528, - 7.6304, - 4.7529, - 7.1806, - 4.7529 - ], - "spans": [ - { - "offset": 535, - "length": 5 - } - ] - }, - { - "content": "PO-3333", - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ], - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - { - "content": "DATE", - "polygon": [ - 0.7409, - 5.421, - 1.0744, - 5.421, - 1.0744, - 5.5186, - 0.7409, - 5.5186 - ], - "spans": [ - { - "offset": 549, - "length": 4 - } - ] - }, - { - "content": "ITEM CODE", - "polygon": [ - 1.4213, - 5.4197, - 2.1407, - 5.4197, - 2.1407, - 5.5199, - 1.4213, - 5.5199 - ], - "spans": [ - { - "offset": 554, - "length": 9 - } - ] - }, - { - "content": "DESCRIPTION", - "polygon": [ - 2.8516, - 5.4197, - 3.7134, - 5.4197, - 3.7134, - 5.5199, - 2.8516, - 5.5199 - ], - "spans": [ - { - "offset": 564, - "length": 11 - } - ] - }, - { - "content": "QTY", - "polygon": [ - 4.4043, - 5.4197, - 4.6631, - 5.4197, - 4.6631, - 5.5357, - 4.4043, - 5.5357 - ], - "spans": [ - { - "offset": 576, - "length": 3 - } - ] - }, - { - "content": "UM", - "polygon": [ - 5.049, - 5.421, - 5.2654, - 5.421, - 5.2654, - 5.5199, - 5.049, - 5.5199 - ], - "spans": [ - { - "offset": 580, - "length": 2 - } - ] - }, - { - "content": "PRICE", - "polygon": [ - 5.8563, - 5.4199, - 6.2163, - 5.4199, - 6.2163, - 5.5197, - 5.8563, - 5.5197 - ], - "spans": [ - { - "offset": 583, - "length": 5 - } - ] - }, - { - "content": "TAX", - "polygon": [ - 6.7169, - 5.421, - 6.974, - 5.421, - 6.974, - 5.5186, - 6.7169, - 5.5186 - ], - "spans": [ - { - "offset": 589, - "length": 3 - } - ] - }, - { - "content": "AMOUNT", - "polygon": [ - 7.2847, - 5.4197, - 7.9039, - 5.4197, - 7.9039, - 5.5199, - 7.2847, - 5.5199 - ], - "spans": [ - { - "offset": 593, - "length": 6 - } - ] - }, - { - "content": "3/4/2021", - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ], - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - { - "content": "A123", - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ], - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - { - "content": "Consulting Services", - "polygon": [ - 2.3388, - 5.6883, - 3.6278, - 5.6883, - 3.6278, - 5.8312, - 2.3388, - 5.8312 - ], - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - { - "content": "2", - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ], - "spans": [ - { - "offset": 634, - "length": 1 - } - ] - }, - { - "content": "hours", - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ], - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - { - "content": "$30.00", - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ], - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - }, - { - "content": "10%", - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ], - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - { - "content": "$60.00", - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ], - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - { - "content": "3/5/2021", - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ], - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - { - "content": "B456", - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ], - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - { - "content": "Document Fee", - "polygon": [ - 2.345, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 2.345, - 6.0997 - ], - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - { - "content": "3", - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ], - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ], - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - }, - { - "content": "5%", - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ], - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - { - "content": "$30.00", - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ], - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - { - "content": "3/6/2021", - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ], - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - { - "content": "C789", - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ], - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - { - "content": "Printing Fee", - "polygon": [ - 2.345, - 6.2906, - 3.1351, - 6.2906, - 3.1351, - 6.4281, - 2.345, - 6.4281 - ], - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - { - "content": "10", - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ], - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - { - "content": "pages", - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ], - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - { - "content": "$1.00", - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ], - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - }, - { - "content": "20%", - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ], - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ], - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - }, - { - "content": "SUBTOTAL", - "polygon": [ - 6.0282, - 6.9118, - 6.7309, - 6.9118, - 6.7309, - 7.0199, - 6.0282, - 7.0199 - ], - "spans": [ - { - "offset": 759, - "length": 8 - } - ] - }, - { - "content": "$100.00", - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ], - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - { - "content": "SALES TAX", - "polygon": [ - 6.0382, - 7.2089, - 6.728, - 7.2089, - 6.728, - 7.317, - 6.0382, - 7.317 - ], - "spans": [ - { - "offset": 776, - "length": 9 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ], - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - { - "content": "TOTAL", - "polygon": [ - 6.2969, - 7.5089, - 6.7309, - 7.5089, - 6.7309, - 7.617, - 6.2969, - 7.617 - ], - "spans": [ - { - "offset": 793, - "length": 5 - } - ] - }, - { - "content": "$110.00", - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ], - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - { - "content": "PREVIOUS UNPAID BALANCE", - "polygon": [ - 4.8126, - 7.8055, - 6.7249, - 7.8055, - 6.7249, - 7.9137, - 4.8126, - 7.9137 - ], - "spans": [ - { - "offset": 807, - "length": 23 - } - ] - }, - { - "content": "$500.00", - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ], - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - { - "content": "AMOUNT DUE", - "polygon": [ - 5.7652, - 8.1022, - 6.725, - 8.1022, - 6.725, - 8.2104, - 5.7652, - 8.2104 - ], - "spans": [ - { - "offset": 839, - "length": 10 - } - ] - }, - { - "content": "$610.00", - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ], - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - }, - { - "content": "THANK YOU FOR YOUR BUSINESS!", - "polygon": [ - 3.129, - 8.539, - 5.356, - 8.539, - 5.356, - 8.6442, - 3.129, - 8.6442 - ], - "spans": [ - { - "offset": 858, - "length": 28 - } - ] - }, - { - "content": "REMIT TO:", - "polygon": [ - 0.5909, - 9.1607, - 1.2603, - 9.1607, - 1.2603, - 9.2608, - 0.5909, - 9.2608 - ], - "spans": [ - { - "offset": 887, - "length": 9 - } - ] - }, - { - "content": "Contoso Billing", - "polygon": [ - 0.5882, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 0.5882, - 9.5059 - ], - "spans": [ - { - "offset": 897, - "length": 15 - } - ] - }, - { - "content": "123 Remit St", - "polygon": [ - 0.5945, - 9.5717, - 1.4337, - 9.5717, - 1.4337, - 9.681, - 0.5945, - 9.681 - ], - "spans": [ - { - "offset": 913, - "length": 12 - } - ] - }, - { - "content": "New York, NY, 10001", - "polygon": [ - 0.5943, - 9.773, - 1.9882, - 9.773, - 1.9882, - 9.9098, - 0.5943, - 9.9098 - ], - "spans": [ - { - "offset": 926, - "length": 19 - } - ] - } - ], - "spans": [ - { - "offset": 0, - "length": 958 - } - ] - } - ], - "tables": [ - { - "rowCount": 4, - "columnCount": 8, - "cells": [ - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "DATE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4932, - 5.329, - 1.3011, - 5.3213, - 1.3011, - 5.6056, - 0.5009, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 549, - "length": 4 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "ITEM CODE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.3213, - 2.2476, - 5.3213, - 2.2399, - 5.6056, - 1.3011, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 554, - "length": 9 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "DESCRIPTION", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2476, - 5.3213, - 4.3174, - 5.329, - 4.3097, - 5.6056, - 2.2399, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 564, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "QTY", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3174, - 5.329, - 4.7483, - 5.329, - 4.7483, - 5.6056, - 4.3097, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 576, - "length": 3 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "UM", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.329, - 5.5639, - 5.329, - 5.5639, - 5.6056, - 4.7483, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 580, - "length": 2 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "PRICE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.329, - 6.495, - 5.329, - 6.495, - 5.6056, - 5.5639, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 583, - "length": 5 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "TAX", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.329, - 7.1875, - 5.329, - 7.1952, - 5.6056, - 6.495, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 589, - "length": 3 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "AMOUNT", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1875, - 5.329, - 7.9954, - 5.329, - 7.9954, - 5.598, - 7.1952, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 593, - "length": 6 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/4/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5009, - 5.6056, - 1.3011, - 5.6056, - 1.3011, - 5.8976, - 0.5009, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "A123", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.6056, - 2.2399, - 5.6056, - 2.2322, - 5.8976, - 1.3011, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Consulting Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2399, - 5.6056, - 4.3097, - 5.6056, - 4.3097, - 5.8976, - 2.2322, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "2 :unselected:", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 5.6056, - 4.7483, - 5.6056, - 4.7483, - 5.8976, - 4.3097, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 634, - "length": 1 - }, - { - "offset": 946, - "length": 12 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "hours", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.6056, - 5.5639, - 5.6056, - 5.5639, - 5.8976, - 4.7483, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.6056, - 6.495, - 5.6056, - 6.495, - 5.8976, - 5.5639, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "10%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.6056, - 7.1952, - 5.6056, - 7.1952, - 5.8976, - 6.495, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 5.6056, - 7.9954, - 5.598, - 7.9954, - 5.9053, - 7.1952, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/5/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5009, - 5.8976, - 1.3011, - 5.8976, - 1.3011, - 6.1973, - 0.5086, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "B456", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.8976, - 2.2322, - 5.8976, - 2.2245, - 6.1973, - 1.3011, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Document Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2322, - 5.8976, - 4.3097, - 5.8976, - 4.3097, - 6.1973, - 2.2245, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "3", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 5.8976, - 4.7483, - 5.8976, - 4.7483, - 6.1973, - 4.3097, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.8976, - 5.5639, - 5.8976, - 5.5639, - 6.1973, - 4.7483, - 6.1973 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 2, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.8976, - 6.495, - 5.8976, - 6.495, - 6.1973, - 5.5639, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "5%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.8976, - 7.1952, - 5.8976, - 7.1952, - 6.1973, - 6.495, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 5.8976, - 7.9954, - 5.9053, - 7.9954, - 6.1896, - 7.1952, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/6/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5086, - 6.1973, - 1.3011, - 6.1973, - 1.3011, - 6.4969, - 0.5086, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "C789", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 6.1973, - 2.2245, - 6.1973, - 2.2245, - 6.4969, - 1.3011, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Printing Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2245, - 6.1973, - 4.3097, - 6.1973, - 4.3097, - 6.4969, - 2.2245, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "10", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 6.1973, - 4.7483, - 6.1973, - 4.7483, - 6.4969, - 4.3097, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "pages", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 6.1973, - 5.5639, - 6.1973, - 5.5639, - 6.4969, - 4.7483, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$1.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 6.1973, - 6.495, - 6.1973, - 6.495, - 6.4969, - 5.5639, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "20%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 6.1973, - 7.1952, - 6.1973, - 7.1952, - 6.4969, - 6.495, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 6.1973, - 7.9954, - 6.1896, - 7.9954, - 6.5046, - 7.1952, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4901, - 5.3293, - 7.9946, - 5.3289, - 7.9954, - 6.5019, - 0.4906, - 6.502 - ] - } - ], - "spans": [ - { - "offset": 549, - "length": 209 - }, - { - "offset": 946, - "length": 12 - } - ] - }, - { - "rowCount": 2, - "columnCount": 6, - "cells": [ - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SALESPERSON", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4977, - 4.565, - 1.8042, - 4.565, - 1.8119, - 4.8388, - 0.5054, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 472, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "P.O. NUMBER", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.8042, - 4.565, - 3.3105, - 4.565, - 3.3105, - 4.8388, - 1.8119, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 484, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "REQUISITIONER", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3105, - 4.565, - 4.6939, - 4.565, - 4.6862, - 4.8388, - 3.3105, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 496, - "length": 13 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "SHIPPED VIA", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.6939, - 4.565, - 5.7468, - 4.565, - 5.7468, - 4.8388, - 4.6862, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 510, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "F.O.B. POINT", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.7468, - 4.565, - 6.815, - 4.565, - 6.815, - 4.8388, - 5.7468, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 522, - "length": 12 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "TERMS", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.815, - 4.565, - 7.9985, - 4.565, - 7.9985, - 4.8388, - 6.815, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 535, - "length": 5 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5054, - 4.8388, - 1.8119, - 4.8388, - 1.8119, - 5.1058, - 0.5131, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "PO-3333", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.8119, - 4.8388, - 3.3105, - 4.8388, - 3.3105, - 5.1058, - 1.8119, - 5.1058 - ] - } - ], - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3105, - 4.8388, - 4.6862, - 4.8388, - 4.6862, - 5.1058, - 3.3105, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.6862, - 4.8388, - 5.7468, - 4.8388, - 5.7468, - 5.1058, - 4.6862, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.7468, - 4.8388, - 6.815, - 4.8388, - 6.815, - 5.1058, - 5.7468, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.815, - 4.8388, - 7.9985, - 4.8388, - 7.9985, - 5.1125, - 6.815, - 5.1058 - ] - } - ], - "spans": [] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4971, - 4.565, - 7.9889, - 4.5653, - 7.989, - 5.1146, - 0.4963, - 5.1141 - ] - } - ], - "spans": [ - { - "offset": 472, - "length": 76 - } - ] - }, - { - "rowCount": 5, - "columnCount": 2, - "cells": [ - { - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SUBTOTAL", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7474, - 6.7934, - 6.8058, - 6.7934, - 6.8105, - 7.0886, - 4.7474, - 7.0886 - ] - } - ], - "spans": [ - { - "offset": 759, - "length": 8 - } - ] - }, - { - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$100.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8058, - 6.7934, - 7.9981, - 6.7934, - 7.9981, - 7.0934, - 6.8105, - 7.0886 - ] - } - ], - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SALES TAX", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7474, - 7.0886, - 6.8105, - 7.0886, - 6.8105, - 7.3743, - 4.7427, - 7.3743 - ] - } - ], - "spans": [ - { - "offset": 776, - "length": 9 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.0886, - 7.9981, - 7.0934, - 7.9981, - 7.3934, - 6.8105, - 7.3743 - ] - } - ], - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "TOTAL", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.3743, - 6.8105, - 7.3743, - 6.8105, - 7.6839, - 4.7427, - 7.6839 - ] - } - ], - "spans": [ - { - "offset": 793, - "length": 5 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$110.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.3743, - 7.9981, - 7.3934, - 7.9981, - 7.6886, - 6.8105, - 7.6839 - ] - } - ], - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "PREVIOUS UNPAID BALANCE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.6839, - 6.8105, - 7.6839, - 6.8105, - 7.9743, - 4.7427, - 7.9743 - ] - } - ], - "spans": [ - { - "offset": 807, - "length": 23 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$500.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.6839, - 7.9981, - 7.6886, - 7.9981, - 7.9839, - 6.8105, - 7.9743 - ] - } - ], - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - { - "rowIndex": 4, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "AMOUNT DUE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.9743, - 6.8105, - 7.9743, - 6.8105, - 8.2839, - 4.7381, - 8.2839 - ] - } - ], - "spans": [ - { - "offset": 839, - "length": 10 - } - ] - }, - { - "rowIndex": 4, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$610.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.9743, - 7.9981, - 7.9839, - 7.9981, - 8.2839, - 6.8105, - 8.2839 - ] - } - ], - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7456, - 6.7793, - 8.0143, - 6.7788, - 8.0137, - 8.2981, - 4.7446, - 8.2981 - ] - } - ], - "spans": [ - { - "offset": 759, - "length": 98 - } - ] - } - ], - "documents": [ - { - "docType": "prebuilt:invoice", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "fields": { - "AmountDue": { - "type": "number", - "valueNumber": 610, - "content": "$610.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - }, - "BillingAddress": { - "type": "string", - "valueString": "123 Bill St, Redmond WA, 98052", - "content": "123 Bill St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 3.9681, - 2.0083, - 3.9681, - 2.0083, - 4.3082, - 0.5943, - 4.3082 - ] - } - ], - "confidence": 0.947, - "spans": [ - { - "offset": 376, - "length": 12 - }, - { - "offset": 418, - "length": 17 - } - ] - }, - "BillingAddressRecipient": { - "type": "string", - "valueString": "Microsoft Finance", - "content": "Microsoft Finance", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 3.7641, - 1.7878, - 3.7641, - 1.7878, - 3.8794, - 0.5943, - 3.8794 - ] - } - ], - "confidence": 0.957, - "spans": [ - { - "offset": 320, - "length": 17 - } - ] - }, - "CustomerAddress": { - "type": "string", - "valueString": "123 Other St, Redmond WA, 98052", - "content": "123 Other St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 2.8476, - 2.0083, - 2.8476, - 2.0083, - 3.1878, - 0.5943, - 3.1878 - ] - } - ], - "confidence": 0.947, - "spans": [ - { - "offset": 253, - "length": 31 - } - ] - }, - "CustomerAddressRecipient": { - "type": "string", - "valueString": "Microsoft Corp", - "content": "Microsoft Corp", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 2.6436, - 1.586, - 2.6436, - 1.586, - 2.7871, - 0.5943, - 2.7871 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 238, - "length": 14 - } - ] - }, - "CustomerId": { - "type": "string", - "valueString": "CID-12345", - "content": "CID-12345", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3369, - 2.4491, - 7.9951, - 2.4491, - 7.9951, - 2.5486, - 7.3369, - 2.5486 - ] - } - ], - "confidence": 0.964, - "spans": [ - { - "offset": 228, - "length": 9 - } - ] - }, - "CustomerName": { - "type": "string", - "valueString": "MICROSOFT CORPORATION", - "content": "MICROSOFT CORPORATION", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2419, - 2.0391, - 7.9825, - 2.0391, - 7.9825, - 2.1386, - 6.2419, - 2.1386 - ] - } - ], - "confidence": 0.949, - "spans": [ - { - "offset": 153, - "length": 21 - } - ] - }, - "DueDate": { - "type": "date", - "valueDate": "2019-12-15", - "content": "12/15/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2494, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 7.2494, - 1.9515 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 127, - "length": 10 - } - ] - }, - "InvoiceDate": { - "type": "date", - "valueDate": "2019-11-15", - "content": "11/15/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2528, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 7.2528, - 1.7449 - ] - } - ], - "confidence": 0.972, - "spans": [ - { - "offset": 86, - "length": 10 - } - ] - }, - "InvoiceId": { - "type": "string", - "valueString": "INV-100", - "content": "INV-100", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4959, - 1.422, - 7.9988, - 1.422, - 7.9988, - 1.5215, - 7.4959, - 1.5215 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 51, - "length": 7 - } - ] - }, - "InvoiceTotal": { - "type": "number", - "valueNumber": 110, - "content": "$110.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - "Items": { - "type": "array", - "valueArray": [ - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 60, - "content": "$60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ] - } - ], - "confidence": 0.902, - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-04", - "content": "3/4/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ] - } - ], - "confidence": 0.938, - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Consulting Services", - "content": "Consulting Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.3388, - 5.6883, - 3.6278, - 5.6883, - 3.6278, - 5.8312, - 2.3388, - 5.8312 - ] - } - ], - "confidence": 0.9, - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "A123", - "content": "A123", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ] - } - ], - "confidence": 0.877, - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 2, - "content": "2", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 634, - "length": 1 - } - ] - }, - "Tax": { - "type": "number", - "content": "10%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ] - } - ], - "confidence": 0.78, - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - "Unit": { - "type": "string", - "valueString": "hours", - "content": "hours", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 30, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ] - } - ], - "confidence": 0.828, - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - } - }, - "content": "3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8312, - 0.592, - 5.8312 - ] - } - ], - "confidence": 0.955, - "spans": [ - { - "offset": 600, - "length": 59 - } - ] - }, - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 30, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ] - } - ], - "confidence": 0.916, - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-05", - "content": "3/5/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ] - } - ], - "confidence": 0.902, - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Document Fee", - "content": "Document Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.345, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 2.345, - 6.0997 - ] - } - ], - "confidence": 0.901, - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "B456", - "content": "B456", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ] - } - ], - "confidence": 0.886, - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 3, - "content": "3", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ] - } - ], - "confidence": 0.898, - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - "Tax": { - "type": "number", - "content": "5%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ] - } - ], - "confidence": 0.772, - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ] - } - ], - "confidence": 0.831, - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - } - }, - "content": "3/5/2021 B456 Document Fee 3 $10.00 5% $30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.121, - 0.592, - 6.121 - ] - } - ], - "confidence": 0.941, - "spans": [ - { - "offset": 660, - "length": 45 - } - ] - }, - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ] - } - ], - "confidence": 0.959, - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-06", - "content": "3/6/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ] - } - ], - "confidence": 0.903, - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Printing Fee", - "content": "Printing Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.345, - 6.2906, - 3.1351, - 6.2906, - 3.1351, - 6.4281, - 2.345, - 6.4281 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "C789", - "content": "C789", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ] - } - ], - "confidence": 0.898, - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 10, - "content": "10", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ] - } - ], - "confidence": 0.903, - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - "Tax": { - "type": "number", - "content": "20%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ] - } - ], - "confidence": 0.791, - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - "Unit": { - "type": "string", - "valueString": "pages", - "content": "pages", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 1, - "content": "$1.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ] - } - ], - "confidence": 0.829, - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - } - }, - "content": "3/6/2021 C789 Printing Fee 10 pages $1.00 20% $10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4281, - 0.592, - 6.4281 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 706, - "length": 52 - } - ] - } - ] - }, - "Locale": { - "type": "string", - "valueString": "en-US", - "confidence": 1 - }, - "PreviousUnpaidBalance": { - "type": "number", - "valueNumber": 500, - "content": "$500.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ] - } - ], - "confidence": 0.962, - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - "PurchaseOrder": { - "type": "string", - "valueString": "PO-3333", - "content": "PO-3333", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ] - } - ], - "confidence": 0.967, - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - "RemittanceAddress": { - "type": "string", - "valueString": "123 Remit St New York, NY, 10001", - "content": "123 Remit St New York, NY, 10001", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 9.5717, - 1.9882, - 9.5717, - 1.9882, - 9.9098, - 0.5943, - 9.9098 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 913, - "length": 32 - } - ] - }, - "RemittanceAddressRecipient": { - "type": "string", - "valueString": "Contoso Billing", - "content": "Contoso Billing", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5882, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 0.5882, - 9.5059 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 897, - "length": 15 - } - ] - }, - "ServiceAddress": { - "type": "string", - "valueString": "123 Service St, Redmond WA, 98052", - "content": "123 Service St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2197, - 3.9734, - 7.6337, - 3.9734, - 7.6337, - 4.3082, - 6.2197, - 4.3082 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 402, - "length": 15 - }, - { - "offset": 454, - "length": 17 - } - ] - }, - "ServiceAddressRecipient": { - "type": "string", - "valueString": "Microsoft Services", - "content": "Microsoft Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2197, - 3.7641, - 7.4427, - 3.7641, - 7.4427, - 3.8794, - 6.2197, - 3.8794 - ] - } - ], - "confidence": 0.951, - "spans": [ - { - "offset": 357, - "length": 18 - } - ] - }, - "ServiceEndDate": { - "type": "date", - "valueDate": "2019-11-14", - "content": "11/14/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2528, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 7.2528, - 2.3615 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 204, - "length": 10 - } - ] - }, - "ServiceStartDate": { - "type": "date", - "valueDate": "2019-10-14", - "content": "10/14/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.3357, - 2.2306, - 7.0749, - 2.2306, - 7.0749, - 2.3615, - 6.3357, - 2.3615 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 191, - "length": 10 - } - ] - }, - "ShippingAddress": { - "type": "string", - "valueString": "123 Ship St, Redmond WA, 98052", - "content": "123 Ship St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3454, - 3.9681, - 4.7594, - 3.9681, - 4.7594, - 4.3082, - 3.3454, - 4.3082 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 389, - "length": 12 - }, - { - "offset": 436, - "length": 17 - } - ] - }, - "ShippingAddressRecipient": { - "type": "string", - "valueString": "Microsoft Delivery", - "content": "Microsoft Delivery", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3454, - 3.7641, - 4.5762, - 3.7641, - 4.5762, - 3.9076, - 3.3454, - 3.9076 - ] - } - ], - "confidence": 0.955, - "spans": [ - { - "offset": 338, - "length": 18 - } - ] - }, - "SubTotal": { - "type": "number", - "valueNumber": 100, - "content": "$100.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - "TotalTax": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - "VendorAddress": { - "type": "string", - "valueString": "123 456th St New York, NY, 10001", - "content": "123 456th St New York, NY, 10001", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 1.6092, - 1.9894, - 1.6092, - 1.9894, - 1.9675, - 0.5943, - 1.9675 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 59, - "length": 12 - }, - { - "offset": 97, - "length": 19 - } - ] - }, - "VendorAddressRecipient": { - "type": "string", - "valueString": "Contoso Headquarters", - "content": "Contoso Headquarters", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5882, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 0.5882, - 1.5664 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 21, - "length": 20 - } - ] - }, - "VendorName": { - "type": "string", - "valueString": "CONTOSO LTD.", - "content": "CONTOSO LTD.", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5911, - 0.6857, - 2.3181, - 0.6857, - 2.3181, - 0.8664, - 0.5911, - 0.8664 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 0, - "length": 12 - } - ] - } - }, - "confidence": 1, - "spans": [ - { - "offset": 0, - "length": 958 - } - ] - } - ] - } - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "prebuilt-invoice", + "resultId": "{resultId}" + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2021-09-24T13:00:46Z", + "lastUpdatedDateTime": "2021-09-24T13:00:49Z", + "analyzeResult": { + "apiVersion": "{apiVersion}", + "modelId": "prebuilt-invoice", + "stringIndexType": "textElements", + "content": "CONTOSO LTD.\nINVOICE\nContoso Headquarters\nINVOICE: INV-100\n123 456th St\nINVOICE DATE: 11/15/2019\nNew York, NY, 10001\nDUE DATE: 12/15/2019\nCUSTOMER NAME: MICROSOFT CORPORATION\nSERVICE PERIOD: 10/14/2019 – 11/14/2019\nCUSTOMER ID: CID-12345\nMicrosoft Corp\n123 Other St,\nRedmond WA, 98052\nBILL TO:\nSHIP TO:\nSERVICE ADDRESS:\nMicrosoft Finance\nMicrosoft Delivery\nMicrosoft Services\n123 Bill St,\n123 Ship St,\n123 Service St,\nRedmond WA, 98052\nRedmond WA, 98052\nRedmond WA, 98052\nSALESPERSON\nP.O. NUMBER\nREQUISITIONER\nSHIPPED VIA\nF.O.B. POINT\nTERMS\nPO-3333\nDATE\nITEM CODE\nDESCRIPTION\nQTY\nUM\nPRICE\nTAX\nAMOUNT\n3/4/2021\nA123\nConsulting Services\n2\nhours\n$30.00\n10%\n$60.00\n3/5/2021\nB456\nDocument Fee\n3\n$10.00\n5%\n$30.00\n3/6/2021\nC789\nPrinting Fee\n10\npages\n$1.00\n20%\n$10.00\nSUBTOTAL\n$100.00\nSALES TAX\n$10.00\nTOTAL\n$110.00\nPREVIOUS UNPAID BALANCE\n$500.00\nAMOUNT DUE\n$610.00\nTHANK YOU FOR YOUR BUSINESS!\nREMIT TO:\nContoso Billing\n123 Remit St\nNew York, NY, 10001\n:unselected:", + "pages": [ + { + "pageNumber": 1, + "angle": 0, + "width": 8.5, + "height": 11, + "unit": "inch", + "words": [ + { + "content": "CONTOSO", + "polygon": [ + 0.5911, + 0.6857, + 1.7451, + 0.6857, + 1.7451, + 0.8664, + 0.5911, + 0.8664 + ], + "confidence": 1, + "span": { + "offset": 0, + "length": 7 + } + }, + { + "content": "LTD.", + "polygon": [ + 1.8441, + 0.6879, + 2.3181, + 0.6879, + 2.3181, + 0.865, + 1.8441, + 0.865 + ], + "confidence": 1, + "span": { + "offset": 8, + "length": 4 + } + }, + { + "content": "INVOICE", + "polygon": [ + 7.0751, + 0.589, + 7.9886, + 0.589, + 7.9886, + 0.7697, + 7.0751, + 0.7697 + ], + "confidence": 1, + "span": { + "offset": 13, + "length": 7 + } + }, + { + "content": "Contoso", + "polygon": [ + 0.5882, + 1.4303, + 1.1337, + 1.4303, + 1.1337, + 1.5383, + 0.5882, + 1.5383 + ], + "confidence": 1, + "span": { + "offset": 21, + "length": 7 + } + }, + { + "content": "Headquarters", + "polygon": [ + 1.1905, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 1.1905, + 1.5664 + ], + "confidence": 1, + "span": { + "offset": 29, + "length": 12 + } + }, + { + "content": "INVOICE:", + "polygon": [ + 6.8599, + 1.4217, + 7.4328, + 1.4217, + 7.4328, + 1.5218, + 6.8599, + 1.5218 + ], + "confidence": 1, + "span": { + "offset": 42, + "length": 8 + } + }, + { + "content": "INV-100", + "polygon": [ + 7.4959, + 1.422, + 7.9988, + 1.422, + 7.9988, + 1.5215, + 7.4959, + 1.5215 + ], + "confidence": 1, + "span": { + "offset": 51, + "length": 7 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 1.6339, + 0.8213, + 1.6339, + 0.8213, + 1.742, + 0.5945, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 59, + "length": 3 + } + }, + { + "content": "456th", + "polygon": [ + 0.874, + 1.6092, + 1.2102, + 1.6092, + 1.2102, + 1.742, + 0.874, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 63, + "length": 5 + } + }, + { + "content": "St", + "polygon": [ + 1.2598, + 1.6339, + 1.3812, + 1.6339, + 1.3812, + 1.742, + 1.2598, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 69, + "length": 2 + } + }, + { + "content": "INVOICE", + "polygon": [ + 6.2263, + 1.6254, + 6.7562, + 1.6254, + 6.7562, + 1.7256, + 6.2263, + 1.7256 + ], + "confidence": 1, + "span": { + "offset": 72, + "length": 7 + } + }, + { + "content": "DATE:", + "polygon": [ + 6.8132, + 1.6267, + 7.1891, + 1.6267, + 7.1891, + 1.7248, + 6.8132, + 1.7248 + ], + "confidence": 1, + "span": { + "offset": 80, + "length": 5 + } + }, + { + "content": "11/15/2019", + "polygon": [ + 7.2528, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 7.2528, + 1.7449 + ], + "confidence": 1, + "span": { + "offset": 86, + "length": 10 + } + }, + { + "content": "New", + "polygon": [ + 0.5943, + 1.8385, + 0.8848, + 1.8385, + 0.8848, + 1.9454, + 0.5943, + 1.9454 + ], + "confidence": 1, + "span": { + "offset": 97, + "length": 3 + } + }, + { + "content": "York,", + "polygon": [ + 0.9293, + 1.8307, + 1.2568, + 1.8307, + 1.2568, + 1.9675, + 0.9293, + 1.9675 + ], + "confidence": 1, + "span": { + "offset": 101, + "length": 5 + } + }, + { + "content": "NY,", + "polygon": [ + 1.3205, + 1.8382, + 1.5242, + 1.8382, + 1.5242, + 1.9675, + 1.3205, + 1.9675 + ], + "confidence": 1, + "span": { + "offset": 107, + "length": 3 + } + }, + { + "content": "10001", + "polygon": [ + 1.5915, + 1.8372, + 1.9894, + 1.8372, + 1.9894, + 1.9454, + 1.5915, + 1.9454 + ], + "confidence": 1, + "span": { + "offset": 111, + "length": 5 + } + }, + { + "content": "DUE", + "polygon": [ + 6.4966, + 1.8333, + 6.7569, + 1.8333, + 6.7569, + 1.9322, + 6.4966, + 1.9322 + ], + "confidence": 1, + "span": { + "offset": 117, + "length": 3 + } + }, + { + "content": "DATE:", + "polygon": [ + 6.8126, + 1.8333, + 7.1846, + 1.8333, + 7.1846, + 1.9315, + 6.8126, + 1.9315 + ], + "confidence": 1, + "span": { + "offset": 121, + "length": 5 + } + }, + { + "content": "12/15/2019", + "polygon": [ + 7.2494, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 7.2494, + 1.9515 + ], + "confidence": 1, + "span": { + "offset": 127, + "length": 10 + } + }, + { + "content": "CUSTOMER", + "polygon": [ + 4.9513, + 2.0388, + 5.6868, + 2.0388, + 5.6868, + 2.1389, + 4.9513, + 2.1389 + ], + "confidence": 1, + "span": { + "offset": 138, + "length": 8 + } + }, + { + "content": "NAME:", + "polygon": [ + 5.7412, + 2.04, + 6.1764, + 2.04, + 6.1764, + 2.1381, + 5.7412, + 2.1381 + ], + "confidence": 1, + "span": { + "offset": 147, + "length": 5 + } + }, + { + "content": "MICROSOFT", + "polygon": [ + 6.2419, + 2.0391, + 6.9981, + 2.0391, + 6.9981, + 2.1386, + 6.2419, + 2.1386 + ], + "confidence": 1, + "span": { + "offset": 153, + "length": 9 + } + }, + { + "content": "CORPORATION", + "polygon": [ + 7.0448, + 2.0391, + 7.9825, + 2.0391, + 7.9825, + 2.1386, + 7.0448, + 2.1386 + ], + "confidence": 1, + "span": { + "offset": 163, + "length": 11 + } + }, + { + "content": "SERVICE", + "polygon": [ + 5.1667, + 2.2421, + 5.6923, + 2.2421, + 5.6923, + 2.3422, + 5.1667, + 2.3422 + ], + "confidence": 1, + "span": { + "offset": 175, + "length": 7 + } + }, + { + "content": "PERIOD:", + "polygon": [ + 5.748, + 2.2421, + 6.2721, + 2.2421, + 6.2721, + 2.3422, + 5.748, + 2.3422 + ], + "confidence": 1, + "span": { + "offset": 183, + "length": 7 + } + }, + { + "content": "10/14/2019", + "polygon": [ + 6.3357, + 2.2306, + 7.0749, + 2.2306, + 7.0749, + 2.3615, + 6.3357, + 2.3615 + ], + "confidence": 1, + "span": { + "offset": 191, + "length": 10 + } + }, + { + "content": "–", + "polygon": [ + 7.122, + 2.2922, + 7.1995, + 2.2922, + 7.1995, + 2.3037, + 7.122, + 2.3037 + ], + "confidence": 1, + "span": { + "offset": 202, + "length": 1 + } + }, + { + "content": "11/14/2019", + "polygon": [ + 7.2528, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 7.2528, + 2.3615 + ], + "confidence": 1, + "span": { + "offset": 204, + "length": 10 + } + }, + { + "content": "CUSTOMER", + "polygon": [ + 6.3253, + 2.4488, + 7.0608, + 2.4488, + 7.0608, + 2.5489, + 6.3253, + 2.5489 + ], + "confidence": 1, + "span": { + "offset": 215, + "length": 8 + } + }, + { + "content": "ID:", + "polygon": [ + 7.1153, + 2.45, + 7.2809, + 2.45, + 7.2809, + 2.5481, + 7.1153, + 2.5481 + ], + "confidence": 1, + "span": { + "offset": 224, + "length": 3 + } + }, + { + "content": "CID-12345", + "polygon": [ + 7.3369, + 2.4491, + 7.9951, + 2.4491, + 7.9951, + 2.5486, + 7.3369, + 2.5486 + ], + "confidence": 1, + "span": { + "offset": 228, + "length": 9 + } + }, + { + "content": "Microsoft", + "polygon": [ + 0.5943, + 2.6436, + 1.2303, + 2.6436, + 1.2303, + 2.759, + 0.5943, + 2.759 + ], + "confidence": 1, + "span": { + "offset": 238, + "length": 9 + } + }, + { + "content": "Corp", + "polygon": [ + 1.2808, + 2.651, + 1.586, + 2.651, + 1.586, + 2.7871, + 1.2808, + 2.7871 + ], + "confidence": 1, + "span": { + "offset": 248, + "length": 4 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 2.8541, + 0.8213, + 2.8541, + 0.8213, + 2.9623, + 0.5945, + 2.9623 + ], + "confidence": 1, + "span": { + "offset": 253, + "length": 3 + } + }, + { + "content": "Other", + "polygon": [ + 0.875, + 2.8476, + 1.262, + 2.8476, + 1.262, + 2.9623, + 0.875, + 2.9623 + ], + "confidence": 1, + "span": { + "offset": 257, + "length": 5 + } + }, + { + "content": "St,", + "polygon": [ + 1.3058, + 2.8541, + 1.4633, + 2.8541, + 1.4633, + 2.9845, + 1.3058, + 2.9845 + ], + "confidence": 1, + "span": { + "offset": 263, + "length": 3 + } + }, + { + "content": "Redmond", + "polygon": [ + 0.5943, + 3.0513, + 1.2222, + 3.0513, + 1.2222, + 3.1656, + 0.5943, + 3.1656 + ], + "confidence": 1, + "span": { + "offset": 267, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 1.2753, + 3.0585, + 1.5468, + 3.0585, + 1.5468, + 3.1878, + 1.2753, + 3.1878 + ], + "confidence": 1, + "span": { + "offset": 275, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 1.6033, + 3.0575, + 2.0083, + 3.0575, + 2.0083, + 3.1656, + 1.6033, + 3.1656 + ], + "confidence": 1, + "span": { + "offset": 279, + "length": 5 + } + }, + { + "content": "BILL", + "polygon": [ + 0.5909, + 3.5603, + 0.8438, + 3.5603, + 0.8438, + 3.6579, + 0.5909, + 3.6579 + ], + "confidence": 1, + "span": { + "offset": 285, + "length": 4 + } + }, + { + "content": "TO:", + "polygon": [ + 0.8846, + 3.559, + 1.1032, + 3.559, + 1.1032, + 3.6592, + 0.8846, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 290, + "length": 3 + } + }, + { + "content": "SHIP", + "polygon": [ + 3.3361, + 3.559, + 3.6278, + 3.559, + 3.6278, + 3.6592, + 3.3361, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 294, + "length": 4 + } + }, + { + "content": "TO:", + "polygon": [ + 3.6716, + 3.559, + 3.8903, + 3.559, + 3.8903, + 3.6592, + 3.6716, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 299, + "length": 3 + } + }, + { + "content": "SERVICE", + "polygon": [ + 6.2104, + 3.559, + 6.7361, + 3.559, + 6.7361, + 3.6592, + 6.2104, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 303, + "length": 7 + } + }, + { + "content": "ADDRESS:", + "polygon": [ + 6.7828, + 3.559, + 7.4232, + 3.559, + 7.4232, + 3.6592, + 6.7828, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 311, + "length": 8 + } + }, + { + "content": "Microsoft", + "polygon": [ + 0.5943, + 3.7641, + 1.2303, + 3.7641, + 1.2303, + 3.8794, + 0.5943, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 320, + "length": 9 + } + }, + { + "content": "Finance", + "polygon": [ + 1.287, + 3.7701, + 1.7878, + 3.7701, + 1.7878, + 3.8794, + 1.287, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 330, + "length": 7 + } + }, + { + "content": "Microsoft", + "polygon": [ + 3.3454, + 3.7641, + 3.9814, + 3.7641, + 3.9814, + 3.8794, + 3.3454, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 338, + "length": 9 + } + }, + { + "content": "Delivery", + "polygon": [ + 4.0381, + 3.7647, + 4.5762, + 3.7647, + 4.5762, + 3.9076, + 4.0381, + 3.9076 + ], + "confidence": 1, + "span": { + "offset": 348, + "length": 8 + } + }, + { + "content": "Microsoft", + "polygon": [ + 6.2197, + 3.7641, + 6.8557, + 3.7641, + 6.8557, + 3.8794, + 6.2197, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 357, + "length": 9 + } + }, + { + "content": "Services", + "polygon": [ + 6.9042, + 3.7701, + 7.4427, + 3.7701, + 7.4427, + 3.8794, + 6.9042, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 367, + "length": 8 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 3.9746, + 0.8213, + 3.9746, + 0.8213, + 4.0827, + 0.5945, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 376, + "length": 3 + } + }, + { + "content": "Bill", + "polygon": [ + 0.8842, + 3.9681, + 1.0657, + 3.9681, + 1.0657, + 4.0817, + 0.8842, + 4.0817 + ], + "confidence": 1, + "span": { + "offset": 380, + "length": 4 + } + }, + { + "content": "St,", + "polygon": [ + 1.1222, + 3.9746, + 1.2765, + 3.9746, + 1.2765, + 4.1049, + 1.1222, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 385, + "length": 3 + } + }, + { + "content": "123", + "polygon": [ + 3.3456, + 3.9746, + 3.5724, + 3.9746, + 3.5724, + 4.0827, + 3.3456, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 389, + "length": 3 + } + }, + { + "content": "Ship", + "polygon": [ + 3.6239, + 3.9681, + 3.9042, + 3.9681, + 3.9042, + 4.1109, + 3.6239, + 4.1109 + ], + "confidence": 1, + "span": { + "offset": 393, + "length": 4 + } + }, + { + "content": "St,", + "polygon": [ + 3.9536, + 3.9746, + 4.1111, + 3.9746, + 4.1111, + 4.1049, + 3.9536, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 398, + "length": 3 + } + }, + { + "content": "123", + "polygon": [ + 6.2199, + 3.9746, + 6.4467, + 3.9746, + 6.4467, + 4.0827, + 6.2199, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 402, + "length": 3 + } + }, + { + "content": "Service", + "polygon": [ + 6.4985, + 3.9734, + 6.9738, + 3.9734, + 6.9738, + 4.0827, + 6.4985, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 406, + "length": 7 + } + }, + { + "content": "St,", + "polygon": [ + 7.0246, + 3.9746, + 7.1821, + 3.9746, + 7.1821, + 4.1049, + 7.0246, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 414, + "length": 3 + } + }, + { + "content": "Redmond", + "polygon": [ + 0.5943, + 4.1717, + 1.2222, + 4.1717, + 1.2222, + 4.2861, + 0.5943, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 418, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 1.2753, + 4.1789, + 1.5468, + 4.1789, + 1.5468, + 4.3082, + 1.2753, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 426, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 1.6033, + 4.1779, + 2.0083, + 4.1779, + 2.0083, + 4.2861, + 1.6033, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 430, + "length": 5 + } + }, + { + "content": "Redmond", + "polygon": [ + 3.3454, + 4.1717, + 3.9732, + 4.1717, + 3.9732, + 4.2861, + 3.3454, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 436, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 4.0264, + 4.1789, + 4.2979, + 4.1789, + 4.2979, + 4.3082, + 4.0264, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 444, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 4.3544, + 4.1779, + 4.7594, + 4.1779, + 4.7594, + 4.2861, + 4.3544, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 448, + "length": 5 + } + }, + { + "content": "Redmond", + "polygon": [ + 6.2197, + 4.1717, + 6.8475, + 4.1717, + 6.8475, + 4.2861, + 6.2197, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 454, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 6.9007, + 4.1789, + 7.1722, + 4.1789, + 7.1722, + 4.3082, + 6.9007, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 462, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 7.2287, + 4.1779, + 7.6337, + 4.1779, + 7.6337, + 4.2861, + 7.2287, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 466, + "length": 5 + } + }, + { + "content": "SALESPERSON", + "polygon": [ + 0.7018, + 4.6528, + 1.6092, + 4.6528, + 1.6092, + 4.7529, + 0.7018, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 472, + "length": 11 + } + }, + { + "content": "P.O.", + "polygon": [ + 2.1216, + 4.6528, + 2.3788, + 4.6528, + 2.3788, + 4.7529, + 2.1216, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 484, + "length": 4 + } + }, + { + "content": "NUMBER", + "polygon": [ + 2.4376, + 4.654, + 3.0155, + 4.654, + 3.0155, + 4.7529, + 2.4376, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 489, + "length": 6 + } + }, + { + "content": "REQUISITIONER", + "polygon": [ + 3.4953, + 4.6528, + 4.5157, + 4.6528, + 4.5157, + 4.7687, + 3.4953, + 4.7687 + ], + "confidence": 1, + "span": { + "offset": 496, + "length": 13 + } + }, + { + "content": "SHIPPED", + "polygon": [ + 4.81, + 4.6528, + 5.362, + 4.6528, + 5.362, + 4.7529, + 4.81, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 510, + "length": 7 + } + }, + { + "content": "VIA", + "polygon": [ + 5.409, + 4.654, + 5.6317, + 4.654, + 5.6317, + 4.7517, + 5.409, + 4.7517 + ], + "confidence": 1, + "span": { + "offset": 518, + "length": 3 + } + }, + { + "content": "F.O.B.", + "polygon": [ + 5.8696, + 4.6528, + 6.2467, + 4.6528, + 6.2467, + 4.7529, + 5.8696, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 522, + "length": 6 + } + }, + { + "content": "POINT", + "polygon": [ + 6.3054, + 4.6528, + 6.706, + 4.6528, + 6.706, + 4.7529, + 6.3054, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 529, + "length": 5 + } + }, + { + "content": "TERMS", + "polygon": [ + 7.1806, + 4.6528, + 7.6304, + 4.6528, + 7.6304, + 4.7529, + 7.1806, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 535, + "length": 5 + } + }, + { + "content": "PO-3333", + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ], + "confidence": 1, + "span": { + "offset": 541, + "length": 7 + } + }, + { + "content": "DATE", + "polygon": [ + 0.7409, + 5.421, + 1.0744, + 5.421, + 1.0744, + 5.5186, + 0.7409, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 549, + "length": 4 + } + }, + { + "content": "ITEM", + "polygon": [ + 1.4213, + 5.421, + 1.7338, + 5.421, + 1.7338, + 5.5186, + 1.4213, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 554, + "length": 4 + } + }, + { + "content": "CODE", + "polygon": [ + 1.7893, + 5.4197, + 2.1407, + 5.4197, + 2.1407, + 5.5199, + 1.7893, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 559, + "length": 4 + } + }, + { + "content": "DESCRIPTION", + "polygon": [ + 2.8516, + 5.4197, + 3.7134, + 5.4197, + 3.7134, + 5.5199, + 2.8516, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 564, + "length": 11 + } + }, + { + "content": "QTY", + "polygon": [ + 4.4043, + 5.4197, + 4.6631, + 5.4197, + 4.6631, + 5.5357, + 4.4043, + 5.5357 + ], + "confidence": 1, + "span": { + "offset": 576, + "length": 3 + } + }, + { + "content": "UM", + "polygon": [ + 5.049, + 5.421, + 5.2654, + 5.421, + 5.2654, + 5.5199, + 5.049, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 580, + "length": 2 + } + }, + { + "content": "PRICE", + "polygon": [ + 5.8563, + 5.4199, + 6.2163, + 5.4199, + 6.2163, + 5.5197, + 5.8563, + 5.5197 + ], + "confidence": 1, + "span": { + "offset": 583, + "length": 5 + } + }, + { + "content": "TAX", + "polygon": [ + 6.7169, + 5.421, + 6.974, + 5.421, + 6.974, + 5.5186, + 6.7169, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 589, + "length": 3 + } + }, + { + "content": "AMOUNT", + "polygon": [ + 7.2847, + 5.4197, + 7.9039, + 5.4197, + 7.9039, + 5.5199, + 7.2847, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 593, + "length": 6 + } + }, + { + "content": "3/4/2021", + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ], + "confidence": 1, + "span": { + "offset": 600, + "length": 8 + } + }, + { + "content": "A123", + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 609, + "length": 4 + } + }, + { + "content": "Consulting", + "polygon": [ + 2.3388, + 5.6883, + 3.0438, + 5.6883, + 3.0438, + 5.8312, + 2.3388, + 5.8312 + ], + "confidence": 1, + "span": { + "offset": 614, + "length": 10 + } + }, + { + "content": "Services", + "polygon": [ + 3.0925, + 5.6937, + 3.6278, + 5.6937, + 3.6278, + 5.803, + 3.0925, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 625, + "length": 8 + } + }, + { + "content": "2", + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ], + "confidence": 1, + "span": { + "offset": 634, + "length": 1 + } + }, + { + "content": "hours", + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 636, + "length": 5 + } + }, + { + "content": "$30.00", + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ], + "confidence": 1, + "span": { + "offset": 642, + "length": 6 + } + }, + { + "content": "10%", + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ], + "confidence": 1, + "span": { + "offset": 649, + "length": 3 + } + }, + { + "content": "$60.00", + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ], + "confidence": 1, + "span": { + "offset": 653, + "length": 6 + } + }, + { + "content": "3/5/2021", + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ], + "confidence": 1, + "span": { + "offset": 660, + "length": 8 + } + }, + { + "content": "B456", + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 669, + "length": 4 + } + }, + { + "content": "Document", + "polygon": [ + 2.345, + 5.993, + 3.0318, + 5.993, + 3.0318, + 6.0997, + 2.345, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 674, + "length": 8 + } + }, + { + "content": "Fee", + "polygon": [ + 3.0887, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 3.0887, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 683, + "length": 3 + } + }, + { + "content": "3", + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 687, + "length": 1 + } + }, + { + "content": "$10.00", + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ], + "confidence": 1, + "span": { + "offset": 689, + "length": 6 + } + }, + { + "content": "5%", + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ], + "confidence": 1, + "span": { + "offset": 696, + "length": 2 + } + }, + { + "content": "$30.00", + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ], + "confidence": 1, + "span": { + "offset": 699, + "length": 6 + } + }, + { + "content": "3/6/2021", + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ], + "confidence": 1, + "span": { + "offset": 706, + "length": 8 + } + }, + { + "content": "C789", + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 715, + "length": 4 + } + }, + { + "content": "Printing", + "polygon": [ + 2.345, + 6.2906, + 2.8575, + 6.2906, + 2.8575, + 6.4281, + 2.345, + 6.4281 + ], + "confidence": 1, + "span": { + "offset": 720, + "length": 8 + } + }, + { + "content": "Fee", + "polygon": [ + 2.9143, + 6.2933, + 3.1351, + 6.2933, + 3.1351, + 6.3999, + 2.9143, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 729, + "length": 3 + } + }, + { + "content": "10", + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 733, + "length": 2 + } + }, + { + "content": "pages", + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ], + "confidence": 1, + "span": { + "offset": 736, + "length": 5 + } + }, + { + "content": "$1.00", + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ], + "confidence": 1, + "span": { + "offset": 742, + "length": 5 + } + }, + { + "content": "20%", + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ], + "confidence": 1, + "span": { + "offset": 748, + "length": 3 + } + }, + { + "content": "$10.00", + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ], + "confidence": 1, + "span": { + "offset": 752, + "length": 6 + } + }, + { + "content": "SUBTOTAL", + "polygon": [ + 6.0282, + 6.9118, + 6.7309, + 6.9118, + 6.7309, + 7.0199, + 6.0282, + 7.0199 + ], + "confidence": 1, + "span": { + "offset": 759, + "length": 8 + } + }, + { + "content": "$100.00", + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ], + "confidence": 1, + "span": { + "offset": 768, + "length": 7 + } + }, + { + "content": "SALES", + "polygon": [ + 6.0382, + 7.2089, + 6.4262, + 7.2089, + 6.4262, + 7.317, + 6.0382, + 7.317 + ], + "confidence": 1, + "span": { + "offset": 776, + "length": 5 + } + }, + { + "content": "TAX", + "polygon": [ + 6.4702, + 7.2099, + 6.728, + 7.2099, + 6.728, + 7.316, + 6.4702, + 7.316 + ], + "confidence": 1, + "span": { + "offset": 782, + "length": 3 + } + }, + { + "content": "$10.00", + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ], + "confidence": 1, + "span": { + "offset": 786, + "length": 6 + } + }, + { + "content": "TOTAL", + "polygon": [ + 6.2969, + 7.5089, + 6.7309, + 7.5089, + 6.7309, + 7.617, + 6.2969, + 7.617 + ], + "confidence": 1, + "span": { + "offset": 793, + "length": 5 + } + }, + { + "content": "$110.00", + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ], + "confidence": 1, + "span": { + "offset": 799, + "length": 7 + } + }, + { + "content": "PREVIOUS", + "polygon": [ + 4.8126, + 7.8055, + 5.4789, + 7.8055, + 5.4789, + 7.9137, + 4.8126, + 7.9137 + ], + "confidence": 1, + "span": { + "offset": 807, + "length": 8 + } + }, + { + "content": "UNPAID", + "polygon": [ + 5.5362, + 7.8065, + 6.057, + 7.8065, + 6.057, + 7.9137, + 5.5362, + 7.9137 + ], + "confidence": 1, + "span": { + "offset": 816, + "length": 6 + } + }, + { + "content": "BALANCE", + "polygon": [ + 6.1164, + 7.8057, + 6.7249, + 7.8057, + 6.7249, + 7.9135, + 6.1164, + 7.9135 + ], + "confidence": 1, + "span": { + "offset": 823, + "length": 7 + } + }, + { + "content": "$500.00", + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ], + "confidence": 1, + "span": { + "offset": 831, + "length": 7 + } + }, + { + "content": "AMOUNT", + "polygon": [ + 5.7652, + 8.1022, + 6.4055, + 8.1022, + 6.4055, + 8.2104, + 5.7652, + 8.2104 + ], + "confidence": 1, + "span": { + "offset": 839, + "length": 6 + } + }, + { + "content": "DUE", + "polygon": [ + 6.4562, + 8.1032, + 6.725, + 8.1032, + 6.725, + 8.2104, + 6.4562, + 8.2104 + ], + "confidence": 1, + "span": { + "offset": 846, + "length": 3 + } + }, + { + "content": "$610.00", + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ], + "confidence": 1, + "span": { + "offset": 850, + "length": 7 + } + }, + { + "content": "THANK", + "polygon": [ + 3.129, + 8.5453, + 3.5887, + 8.5453, + 3.5887, + 8.6429, + 3.129, + 8.6429 + ], + "confidence": 1, + "span": { + "offset": 858, + "length": 5 + } + }, + { + "content": "YOU", + "polygon": [ + 3.6316, + 8.544, + 3.9064, + 8.544, + 3.9064, + 8.6442, + 3.6316, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 864, + "length": 3 + } + }, + { + "content": "FOR", + "polygon": [ + 3.9671, + 8.544, + 4.2187, + 8.544, + 4.2187, + 8.6442, + 3.9671, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 868, + "length": 3 + } + }, + { + "content": "YOUR", + "polygon": [ + 4.2638, + 8.544, + 4.6347, + 8.544, + 4.6347, + 8.6442, + 4.2638, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 872, + "length": 4 + } + }, + { + "content": "BUSINESS!", + "polygon": [ + 4.6859, + 8.539, + 5.356, + 8.539, + 5.356, + 8.6442, + 4.6859, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 877, + "length": 9 + } + }, + { + "content": "REMIT", + "polygon": [ + 0.5909, + 9.1619, + 1.0014, + 9.1619, + 1.0014, + 9.2596, + 0.5909, + 9.2596 + ], + "confidence": 1, + "span": { + "offset": 887, + "length": 5 + } + }, + { + "content": "TO:", + "polygon": [ + 1.0446, + 9.1607, + 1.2603, + 9.1607, + 1.2603, + 9.2608, + 1.0446, + 9.2608 + ], + "confidence": 1, + "span": { + "offset": 893, + "length": 3 + } + }, + { + "content": "Contoso", + "polygon": [ + 0.5882, + 9.3697, + 1.1337, + 9.3697, + 1.1337, + 9.4777, + 0.5882, + 9.4777 + ], + "confidence": 1, + "span": { + "offset": 897, + "length": 7 + } + }, + { + "content": "Billing", + "polygon": [ + 1.1905, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 1.1905, + 9.5059 + ], + "confidence": 1, + "span": { + "offset": 905, + "length": 7 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 9.5728, + 0.8213, + 9.5728, + 0.8213, + 9.681, + 0.5945, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 913, + "length": 3 + } + }, + { + "content": "Remit", + "polygon": [ + 0.881, + 9.5717, + 1.264, + 9.5717, + 1.264, + 9.681, + 0.881, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 917, + "length": 5 + } + }, + { + "content": "St", + "polygon": [ + 1.3125, + 9.5728, + 1.4337, + 9.5728, + 1.4337, + 9.681, + 1.3125, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 923, + "length": 2 + } + }, + { + "content": "New", + "polygon": [ + 0.5943, + 9.7808, + 0.8848, + 9.7808, + 0.8848, + 9.8877, + 0.5943, + 9.8877 + ], + "confidence": 1, + "span": { + "offset": 926, + "length": 3 + } + }, + { + "content": "York,", + "polygon": [ + 0.9293, + 9.773, + 1.2568, + 9.773, + 1.2568, + 9.9098, + 0.9293, + 9.9098 + ], + "confidence": 1, + "span": { + "offset": 930, + "length": 5 + } + }, + { + "content": "NY,", + "polygon": [ + 1.3205, + 9.7805, + 1.5233, + 9.7805, + 1.5233, + 9.9098, + 1.3205, + 9.9098 + ], + "confidence": 1, + "span": { + "offset": 936, + "length": 3 + } + }, + { + "content": "10001", + "polygon": [ + 1.5903, + 9.7795, + 1.9882, + 9.7795, + 1.9882, + 9.8877, + 1.5903, + 9.8877 + ], + "confidence": 1, + "span": { + "offset": 940, + "length": 5 + } + } + ], + "selectionMarks": [ + { + "state": "unselected", + "polygon": [ + 4.3231, + 5.6279, + 4.7562, + 5.6279, + 4.7562, + 5.8654, + 4.3231, + 5.8654 + ], + "confidence": 0.212, + "span": { + "offset": 946, + "length": 12 + } + } + ], + "lines": [ + { + "content": "CONTOSO LTD.", + "polygon": [ + 0.5911, + 0.6857, + 2.3181, + 0.6857, + 2.3181, + 0.8664, + 0.5911, + 0.8664 + ], + "spans": [ + { + "offset": 0, + "length": 12 + } + ] + }, + { + "content": "INVOICE", + "polygon": [ + 7.0751, + 0.589, + 7.9886, + 0.589, + 7.9886, + 0.7697, + 7.0751, + 0.7697 + ], + "spans": [ + { + "offset": 13, + "length": 7 + } + ] + }, + { + "content": "Contoso Headquarters", + "polygon": [ + 0.5882, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 0.5882, + 1.5664 + ], + "spans": [ + { + "offset": 21, + "length": 20 + } + ] + }, + { + "content": "INVOICE: INV-100", + "polygon": [ + 6.8599, + 1.4217, + 7.9988, + 1.4217, + 7.9988, + 1.5218, + 6.8599, + 1.5218 + ], + "spans": [ + { + "offset": 42, + "length": 16 + } + ] + }, + { + "content": "123 456th St", + "polygon": [ + 0.5945, + 1.6092, + 1.3812, + 1.6092, + 1.3812, + 1.742, + 0.5945, + 1.742 + ], + "spans": [ + { + "offset": 59, + "length": 12 + } + ] + }, + { + "content": "INVOICE DATE: 11/15/2019", + "polygon": [ + 6.2263, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 6.2263, + 1.7449 + ], + "spans": [ + { + "offset": 72, + "length": 24 + } + ] + }, + { + "content": "New York, NY, 10001", + "polygon": [ + 0.5943, + 1.8307, + 1.9894, + 1.8307, + 1.9894, + 1.9675, + 0.5943, + 1.9675 + ], + "spans": [ + { + "offset": 97, + "length": 19 + } + ] + }, + { + "content": "DUE DATE: 12/15/2019", + "polygon": [ + 6.4966, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 6.4966, + 1.9515 + ], + "spans": [ + { + "offset": 117, + "length": 20 + } + ] + }, + { + "content": "CUSTOMER NAME: MICROSOFT CORPORATION", + "polygon": [ + 4.9513, + 2.0388, + 7.9825, + 2.0388, + 7.9825, + 2.1389, + 4.9513, + 2.1389 + ], + "spans": [ + { + "offset": 138, + "length": 36 + } + ] + }, + { + "content": "SERVICE PERIOD: 10/14/2019 – 11/14/2019", + "polygon": [ + 5.1667, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 5.1667, + 2.3615 + ], + "spans": [ + { + "offset": 175, + "length": 39 + } + ] + }, + { + "content": "CUSTOMER ID: CID-12345", + "polygon": [ + 6.3253, + 2.4488, + 7.9951, + 2.4488, + 7.9951, + 2.5489, + 6.3253, + 2.5489 + ], + "spans": [ + { + "offset": 215, + "length": 22 + } + ] + }, + { + "content": "Microsoft Corp", + "polygon": [ + 0.5943, + 2.6436, + 1.586, + 2.6436, + 1.586, + 2.7871, + 0.5943, + 2.7871 + ], + "spans": [ + { + "offset": 238, + "length": 14 + } + ] + }, + { + "content": "123 Other St,", + "polygon": [ + 0.5945, + 2.8476, + 1.4633, + 2.8476, + 1.4633, + 2.9845, + 0.5945, + 2.9845 + ], + "spans": [ + { + "offset": 253, + "length": 13 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 0.5943, + 3.0513, + 2.0083, + 3.0513, + 2.0083, + 3.1878, + 0.5943, + 3.1878 + ], + "spans": [ + { + "offset": 267, + "length": 17 + } + ] + }, + { + "content": "BILL TO:", + "polygon": [ + 0.5909, + 3.559, + 1.1032, + 3.559, + 1.1032, + 3.6592, + 0.5909, + 3.6592 + ], + "spans": [ + { + "offset": 285, + "length": 8 + } + ] + }, + { + "content": "SHIP TO:", + "polygon": [ + 3.3361, + 3.559, + 3.8903, + 3.559, + 3.8903, + 3.6592, + 3.3361, + 3.6592 + ], + "spans": [ + { + "offset": 294, + "length": 8 + } + ] + }, + { + "content": "SERVICE ADDRESS:", + "polygon": [ + 6.2104, + 3.559, + 7.4232, + 3.559, + 7.4232, + 3.6592, + 6.2104, + 3.6592 + ], + "spans": [ + { + "offset": 303, + "length": 16 + } + ] + }, + { + "content": "Microsoft Finance", + "polygon": [ + 0.5943, + 3.7641, + 1.7878, + 3.7641, + 1.7878, + 3.8794, + 0.5943, + 3.8794 + ], + "spans": [ + { + "offset": 320, + "length": 17 + } + ] + }, + { + "content": "Microsoft Delivery", + "polygon": [ + 3.3454, + 3.7641, + 4.5762, + 3.7641, + 4.5762, + 3.9076, + 3.3454, + 3.9076 + ], + "spans": [ + { + "offset": 338, + "length": 18 + } + ] + }, + { + "content": "Microsoft Services", + "polygon": [ + 6.2197, + 3.7641, + 7.4427, + 3.7641, + 7.4427, + 3.8794, + 6.2197, + 3.8794 + ], + "spans": [ + { + "offset": 357, + "length": 18 + } + ] + }, + { + "content": "123 Bill St,", + "polygon": [ + 0.5945, + 3.9681, + 1.2765, + 3.9681, + 1.2765, + 4.1049, + 0.5945, + 4.1049 + ], + "spans": [ + { + "offset": 376, + "length": 12 + } + ] + }, + { + "content": "123 Ship St,", + "polygon": [ + 3.3456, + 3.9681, + 4.1111, + 3.9681, + 4.1111, + 4.1109, + 3.3456, + 4.1109 + ], + "spans": [ + { + "offset": 389, + "length": 12 + } + ] + }, + { + "content": "123 Service St,", + "polygon": [ + 6.2199, + 3.9734, + 7.1821, + 3.9734, + 7.1821, + 4.1049, + 6.2199, + 4.1049 + ], + "spans": [ + { + "offset": 402, + "length": 15 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 0.5943, + 4.1717, + 2.0083, + 4.1717, + 2.0083, + 4.3082, + 0.5943, + 4.3082 + ], + "spans": [ + { + "offset": 418, + "length": 17 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 3.3454, + 4.1717, + 4.7594, + 4.1717, + 4.7594, + 4.3082, + 3.3454, + 4.3082 + ], + "spans": [ + { + "offset": 436, + "length": 17 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 6.2197, + 4.1717, + 7.6337, + 4.1717, + 7.6337, + 4.3082, + 6.2197, + 4.3082 + ], + "spans": [ + { + "offset": 454, + "length": 17 + } + ] + }, + { + "content": "SALESPERSON", + "polygon": [ + 0.7018, + 4.6528, + 1.6092, + 4.6528, + 1.6092, + 4.7529, + 0.7018, + 4.7529 + ], + "spans": [ + { + "offset": 472, + "length": 11 + } + ] + }, + { + "content": "P.O. NUMBER", + "polygon": [ + 2.1216, + 4.6528, + 3.0155, + 4.6528, + 3.0155, + 4.7529, + 2.1216, + 4.7529 + ], + "spans": [ + { + "offset": 484, + "length": 11 + } + ] + }, + { + "content": "REQUISITIONER", + "polygon": [ + 3.4953, + 4.6528, + 4.5157, + 4.6528, + 4.5157, + 4.7687, + 3.4953, + 4.7687 + ], + "spans": [ + { + "offset": 496, + "length": 13 + } + ] + }, + { + "content": "SHIPPED VIA", + "polygon": [ + 4.81, + 4.6528, + 5.6317, + 4.6528, + 5.6317, + 4.7529, + 4.81, + 4.7529 + ], + "spans": [ + { + "offset": 510, + "length": 11 + } + ] + }, + { + "content": "F.O.B. POINT", + "polygon": [ + 5.8696, + 4.6528, + 6.706, + 4.6528, + 6.706, + 4.7529, + 5.8696, + 4.7529 + ], + "spans": [ + { + "offset": 522, + "length": 12 + } + ] + }, + { + "content": "TERMS", + "polygon": [ + 7.1806, + 4.6528, + 7.6304, + 4.6528, + 7.6304, + 4.7529, + 7.1806, + 4.7529 + ], + "spans": [ + { + "offset": 535, + "length": 5 + } + ] + }, + { + "content": "PO-3333", + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ], + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + { + "content": "DATE", + "polygon": [ + 0.7409, + 5.421, + 1.0744, + 5.421, + 1.0744, + 5.5186, + 0.7409, + 5.5186 + ], + "spans": [ + { + "offset": 549, + "length": 4 + } + ] + }, + { + "content": "ITEM CODE", + "polygon": [ + 1.4213, + 5.4197, + 2.1407, + 5.4197, + 2.1407, + 5.5199, + 1.4213, + 5.5199 + ], + "spans": [ + { + "offset": 554, + "length": 9 + } + ] + }, + { + "content": "DESCRIPTION", + "polygon": [ + 2.8516, + 5.4197, + 3.7134, + 5.4197, + 3.7134, + 5.5199, + 2.8516, + 5.5199 + ], + "spans": [ + { + "offset": 564, + "length": 11 + } + ] + }, + { + "content": "QTY", + "polygon": [ + 4.4043, + 5.4197, + 4.6631, + 5.4197, + 4.6631, + 5.5357, + 4.4043, + 5.5357 + ], + "spans": [ + { + "offset": 576, + "length": 3 + } + ] + }, + { + "content": "UM", + "polygon": [ + 5.049, + 5.421, + 5.2654, + 5.421, + 5.2654, + 5.5199, + 5.049, + 5.5199 + ], + "spans": [ + { + "offset": 580, + "length": 2 + } + ] + }, + { + "content": "PRICE", + "polygon": [ + 5.8563, + 5.4199, + 6.2163, + 5.4199, + 6.2163, + 5.5197, + 5.8563, + 5.5197 + ], + "spans": [ + { + "offset": 583, + "length": 5 + } + ] + }, + { + "content": "TAX", + "polygon": [ + 6.7169, + 5.421, + 6.974, + 5.421, + 6.974, + 5.5186, + 6.7169, + 5.5186 + ], + "spans": [ + { + "offset": 589, + "length": 3 + } + ] + }, + { + "content": "AMOUNT", + "polygon": [ + 7.2847, + 5.4197, + 7.9039, + 5.4197, + 7.9039, + 5.5199, + 7.2847, + 5.5199 + ], + "spans": [ + { + "offset": 593, + "length": 6 + } + ] + }, + { + "content": "3/4/2021", + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ], + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + { + "content": "A123", + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ], + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + { + "content": "Consulting Services", + "polygon": [ + 2.3388, + 5.6883, + 3.6278, + 5.6883, + 3.6278, + 5.8312, + 2.3388, + 5.8312 + ], + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + { + "content": "2", + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ], + "spans": [ + { + "offset": 634, + "length": 1 + } + ] + }, + { + "content": "hours", + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ], + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + { + "content": "$30.00", + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ], + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + }, + { + "content": "10%", + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ], + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + { + "content": "$60.00", + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ], + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + { + "content": "3/5/2021", + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ], + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + { + "content": "B456", + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ], + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + { + "content": "Document Fee", + "polygon": [ + 2.345, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 2.345, + 6.0997 + ], + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + { + "content": "3", + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ], + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ], + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + }, + { + "content": "5%", + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ], + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + { + "content": "$30.00", + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ], + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + { + "content": "3/6/2021", + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ], + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + { + "content": "C789", + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ], + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + { + "content": "Printing Fee", + "polygon": [ + 2.345, + 6.2906, + 3.1351, + 6.2906, + 3.1351, + 6.4281, + 2.345, + 6.4281 + ], + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + { + "content": "10", + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ], + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + { + "content": "pages", + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ], + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + { + "content": "$1.00", + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ], + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + }, + { + "content": "20%", + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ], + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ], + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + }, + { + "content": "SUBTOTAL", + "polygon": [ + 6.0282, + 6.9118, + 6.7309, + 6.9118, + 6.7309, + 7.0199, + 6.0282, + 7.0199 + ], + "spans": [ + { + "offset": 759, + "length": 8 + } + ] + }, + { + "content": "$100.00", + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ], + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + { + "content": "SALES TAX", + "polygon": [ + 6.0382, + 7.2089, + 6.728, + 7.2089, + 6.728, + 7.317, + 6.0382, + 7.317 + ], + "spans": [ + { + "offset": 776, + "length": 9 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ], + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + { + "content": "TOTAL", + "polygon": [ + 6.2969, + 7.5089, + 6.7309, + 7.5089, + 6.7309, + 7.617, + 6.2969, + 7.617 + ], + "spans": [ + { + "offset": 793, + "length": 5 + } + ] + }, + { + "content": "$110.00", + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ], + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + { + "content": "PREVIOUS UNPAID BALANCE", + "polygon": [ + 4.8126, + 7.8055, + 6.7249, + 7.8055, + 6.7249, + 7.9137, + 4.8126, + 7.9137 + ], + "spans": [ + { + "offset": 807, + "length": 23 + } + ] + }, + { + "content": "$500.00", + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ], + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + { + "content": "AMOUNT DUE", + "polygon": [ + 5.7652, + 8.1022, + 6.725, + 8.1022, + 6.725, + 8.2104, + 5.7652, + 8.2104 + ], + "spans": [ + { + "offset": 839, + "length": 10 + } + ] + }, + { + "content": "$610.00", + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ], + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + }, + { + "content": "THANK YOU FOR YOUR BUSINESS!", + "polygon": [ + 3.129, + 8.539, + 5.356, + 8.539, + 5.356, + 8.6442, + 3.129, + 8.6442 + ], + "spans": [ + { + "offset": 858, + "length": 28 + } + ] + }, + { + "content": "REMIT TO:", + "polygon": [ + 0.5909, + 9.1607, + 1.2603, + 9.1607, + 1.2603, + 9.2608, + 0.5909, + 9.2608 + ], + "spans": [ + { + "offset": 887, + "length": 9 + } + ] + }, + { + "content": "Contoso Billing", + "polygon": [ + 0.5882, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 0.5882, + 9.5059 + ], + "spans": [ + { + "offset": 897, + "length": 15 + } + ] + }, + { + "content": "123 Remit St", + "polygon": [ + 0.5945, + 9.5717, + 1.4337, + 9.5717, + 1.4337, + 9.681, + 0.5945, + 9.681 + ], + "spans": [ + { + "offset": 913, + "length": 12 + } + ] + }, + { + "content": "New York, NY, 10001", + "polygon": [ + 0.5943, + 9.773, + 1.9882, + 9.773, + 1.9882, + 9.9098, + 0.5943, + 9.9098 + ], + "spans": [ + { + "offset": 926, + "length": 19 + } + ] + } + ], + "spans": [ + { + "offset": 0, + "length": 958 + } + ] + } + ], + "tables": [ + { + "rowCount": 4, + "columnCount": 8, + "cells": [ + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "DATE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4932, + 5.329, + 1.3011, + 5.3213, + 1.3011, + 5.6056, + 0.5009, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 549, + "length": 4 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "ITEM CODE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.3213, + 2.2476, + 5.3213, + 2.2399, + 5.6056, + 1.3011, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 554, + "length": 9 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "DESCRIPTION", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2476, + 5.3213, + 4.3174, + 5.329, + 4.3097, + 5.6056, + 2.2399, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 564, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "QTY", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3174, + 5.329, + 4.7483, + 5.329, + 4.7483, + 5.6056, + 4.3097, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 576, + "length": 3 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "UM", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.329, + 5.5639, + 5.329, + 5.5639, + 5.6056, + 4.7483, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 580, + "length": 2 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "PRICE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.329, + 6.495, + 5.329, + 6.495, + 5.6056, + 5.5639, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 583, + "length": 5 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "TAX", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.329, + 7.1875, + 5.329, + 7.1952, + 5.6056, + 6.495, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 589, + "length": 3 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "AMOUNT", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1875, + 5.329, + 7.9954, + 5.329, + 7.9954, + 5.598, + 7.1952, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 593, + "length": 6 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/4/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5009, + 5.6056, + 1.3011, + 5.6056, + 1.3011, + 5.8976, + 0.5009, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "A123", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.6056, + 2.2399, + 5.6056, + 2.2322, + 5.8976, + 1.3011, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Consulting Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2399, + 5.6056, + 4.3097, + 5.6056, + 4.3097, + 5.8976, + 2.2322, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "2 :unselected:", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 5.6056, + 4.7483, + 5.6056, + 4.7483, + 5.8976, + 4.3097, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 634, + "length": 1 + }, + { + "offset": 946, + "length": 12 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "hours", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.6056, + 5.5639, + 5.6056, + 5.5639, + 5.8976, + 4.7483, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.6056, + 6.495, + 5.6056, + 6.495, + 5.8976, + 5.5639, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "10%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.6056, + 7.1952, + 5.6056, + 7.1952, + 5.8976, + 6.495, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 5.6056, + 7.9954, + 5.598, + 7.9954, + 5.9053, + 7.1952, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/5/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5009, + 5.8976, + 1.3011, + 5.8976, + 1.3011, + 6.1973, + 0.5086, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "B456", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.8976, + 2.2322, + 5.8976, + 2.2245, + 6.1973, + 1.3011, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Document Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2322, + 5.8976, + 4.3097, + 5.8976, + 4.3097, + 6.1973, + 2.2245, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "3", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 5.8976, + 4.7483, + 5.8976, + 4.7483, + 6.1973, + 4.3097, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.8976, + 5.5639, + 5.8976, + 5.5639, + 6.1973, + 4.7483, + 6.1973 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 2, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.8976, + 6.495, + 5.8976, + 6.495, + 6.1973, + 5.5639, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "5%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.8976, + 7.1952, + 5.8976, + 7.1952, + 6.1973, + 6.495, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 5.8976, + 7.9954, + 5.9053, + 7.9954, + 6.1896, + 7.1952, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/6/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5086, + 6.1973, + 1.3011, + 6.1973, + 1.3011, + 6.4969, + 0.5086, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "C789", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 6.1973, + 2.2245, + 6.1973, + 2.2245, + 6.4969, + 1.3011, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Printing Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2245, + 6.1973, + 4.3097, + 6.1973, + 4.3097, + 6.4969, + 2.2245, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "10", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 6.1973, + 4.7483, + 6.1973, + 4.7483, + 6.4969, + 4.3097, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "pages", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 6.1973, + 5.5639, + 6.1973, + 5.5639, + 6.4969, + 4.7483, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$1.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 6.1973, + 6.495, + 6.1973, + 6.495, + 6.4969, + 5.5639, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "20%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 6.1973, + 7.1952, + 6.1973, + 7.1952, + 6.4969, + 6.495, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 6.1973, + 7.9954, + 6.1896, + 7.9954, + 6.5046, + 7.1952, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4901, + 5.3293, + 7.9946, + 5.3289, + 7.9954, + 6.5019, + 0.4906, + 6.502 + ] + } + ], + "spans": [ + { + "offset": 549, + "length": 209 + }, + { + "offset": 946, + "length": 12 + } + ] + }, + { + "rowCount": 2, + "columnCount": 6, + "cells": [ + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SALESPERSON", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4977, + 4.565, + 1.8042, + 4.565, + 1.8119, + 4.8388, + 0.5054, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 472, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "P.O. NUMBER", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.8042, + 4.565, + 3.3105, + 4.565, + 3.3105, + 4.8388, + 1.8119, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 484, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "REQUISITIONER", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3105, + 4.565, + 4.6939, + 4.565, + 4.6862, + 4.8388, + 3.3105, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 496, + "length": 13 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "SHIPPED VIA", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.6939, + 4.565, + 5.7468, + 4.565, + 5.7468, + 4.8388, + 4.6862, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 510, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "F.O.B. POINT", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.7468, + 4.565, + 6.815, + 4.565, + 6.815, + 4.8388, + 5.7468, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 522, + "length": 12 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "TERMS", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.815, + 4.565, + 7.9985, + 4.565, + 7.9985, + 4.8388, + 6.815, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 535, + "length": 5 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5054, + 4.8388, + 1.8119, + 4.8388, + 1.8119, + 5.1058, + 0.5131, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "PO-3333", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.8119, + 4.8388, + 3.3105, + 4.8388, + 3.3105, + 5.1058, + 1.8119, + 5.1058 + ] + } + ], + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3105, + 4.8388, + 4.6862, + 4.8388, + 4.6862, + 5.1058, + 3.3105, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.6862, + 4.8388, + 5.7468, + 4.8388, + 5.7468, + 5.1058, + 4.6862, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.7468, + 4.8388, + 6.815, + 4.8388, + 6.815, + 5.1058, + 5.7468, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.815, + 4.8388, + 7.9985, + 4.8388, + 7.9985, + 5.1125, + 6.815, + 5.1058 + ] + } + ], + "spans": [] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4971, + 4.565, + 7.9889, + 4.5653, + 7.989, + 5.1146, + 0.4963, + 5.1141 + ] + } + ], + "spans": [ + { + "offset": 472, + "length": 76 + } + ] + }, + { + "rowCount": 5, + "columnCount": 2, + "cells": [ + { + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SUBTOTAL", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7474, + 6.7934, + 6.8058, + 6.7934, + 6.8105, + 7.0886, + 4.7474, + 7.0886 + ] + } + ], + "spans": [ + { + "offset": 759, + "length": 8 + } + ] + }, + { + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$100.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8058, + 6.7934, + 7.9981, + 6.7934, + 7.9981, + 7.0934, + 6.8105, + 7.0886 + ] + } + ], + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SALES TAX", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7474, + 7.0886, + 6.8105, + 7.0886, + 6.8105, + 7.3743, + 4.7427, + 7.3743 + ] + } + ], + "spans": [ + { + "offset": 776, + "length": 9 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.0886, + 7.9981, + 7.0934, + 7.9981, + 7.3934, + 6.8105, + 7.3743 + ] + } + ], + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "TOTAL", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.3743, + 6.8105, + 7.3743, + 6.8105, + 7.6839, + 4.7427, + 7.6839 + ] + } + ], + "spans": [ + { + "offset": 793, + "length": 5 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$110.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.3743, + 7.9981, + 7.3934, + 7.9981, + 7.6886, + 6.8105, + 7.6839 + ] + } + ], + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "PREVIOUS UNPAID BALANCE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.6839, + 6.8105, + 7.6839, + 6.8105, + 7.9743, + 4.7427, + 7.9743 + ] + } + ], + "spans": [ + { + "offset": 807, + "length": 23 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$500.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.6839, + 7.9981, + 7.6886, + 7.9981, + 7.9839, + 6.8105, + 7.9743 + ] + } + ], + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + { + "rowIndex": 4, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "AMOUNT DUE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.9743, + 6.8105, + 7.9743, + 6.8105, + 8.2839, + 4.7381, + 8.2839 + ] + } + ], + "spans": [ + { + "offset": 839, + "length": 10 + } + ] + }, + { + "rowIndex": 4, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$610.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.9743, + 7.9981, + 7.9839, + 7.9981, + 8.2839, + 6.8105, + 8.2839 + ] + } + ], + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7456, + 6.7793, + 8.0143, + 6.7788, + 8.0137, + 8.2981, + 4.7446, + 8.2981 + ] + } + ], + "spans": [ + { + "offset": 759, + "length": 98 + } + ] + } + ], + "documents": [ + { + "docType": "prebuilt:invoice", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "fields": { + "AmountDue": { + "type": "number", + "valueNumber": 610, + "content": "$610.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + }, + "BillingAddress": { + "type": "string", + "valueString": "123 Bill St, Redmond WA, 98052", + "content": "123 Bill St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 3.9681, + 2.0083, + 3.9681, + 2.0083, + 4.3082, + 0.5943, + 4.3082 + ] + } + ], + "confidence": 0.947, + "spans": [ + { + "offset": 376, + "length": 12 + }, + { + "offset": 418, + "length": 17 + } + ] + }, + "BillingAddressRecipient": { + "type": "string", + "valueString": "Microsoft Finance", + "content": "Microsoft Finance", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 3.7641, + 1.7878, + 3.7641, + 1.7878, + 3.8794, + 0.5943, + 3.8794 + ] + } + ], + "confidence": 0.957, + "spans": [ + { + "offset": 320, + "length": 17 + } + ] + }, + "CustomerAddress": { + "type": "string", + "valueString": "123 Other St, Redmond WA, 98052", + "content": "123 Other St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 2.8476, + 2.0083, + 2.8476, + 2.0083, + 3.1878, + 0.5943, + 3.1878 + ] + } + ], + "confidence": 0.947, + "spans": [ + { + "offset": 253, + "length": 31 + } + ] + }, + "CustomerAddressRecipient": { + "type": "string", + "valueString": "Microsoft Corp", + "content": "Microsoft Corp", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 2.6436, + 1.586, + 2.6436, + 1.586, + 2.7871, + 0.5943, + 2.7871 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 238, + "length": 14 + } + ] + }, + "CustomerId": { + "type": "string", + "valueString": "CID-12345", + "content": "CID-12345", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3369, + 2.4491, + 7.9951, + 2.4491, + 7.9951, + 2.5486, + 7.3369, + 2.5486 + ] + } + ], + "confidence": 0.964, + "spans": [ + { + "offset": 228, + "length": 9 + } + ] + }, + "CustomerName": { + "type": "string", + "valueString": "MICROSOFT CORPORATION", + "content": "MICROSOFT CORPORATION", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2419, + 2.0391, + 7.9825, + 2.0391, + 7.9825, + 2.1386, + 6.2419, + 2.1386 + ] + } + ], + "confidence": 0.949, + "spans": [ + { + "offset": 153, + "length": 21 + } + ] + }, + "DueDate": { + "type": "date", + "valueDate": "2019-12-15", + "content": "12/15/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2494, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 7.2494, + 1.9515 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 127, + "length": 10 + } + ] + }, + "InvoiceDate": { + "type": "date", + "valueDate": "2019-11-15", + "content": "11/15/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2528, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 7.2528, + 1.7449 + ] + } + ], + "confidence": 0.972, + "spans": [ + { + "offset": 86, + "length": 10 + } + ] + }, + "InvoiceId": { + "type": "string", + "valueString": "INV-100", + "content": "INV-100", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4959, + 1.422, + 7.9988, + 1.422, + 7.9988, + 1.5215, + 7.4959, + 1.5215 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 51, + "length": 7 + } + ] + }, + "InvoiceTotal": { + "type": "number", + "valueNumber": 110, + "content": "$110.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + "Items": { + "type": "array", + "valueArray": [ + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 60, + "content": "$60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ] + } + ], + "confidence": 0.902, + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-04", + "content": "3/4/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ] + } + ], + "confidence": 0.938, + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Consulting Services", + "content": "Consulting Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.3388, + 5.6883, + 3.6278, + 5.6883, + 3.6278, + 5.8312, + 2.3388, + 5.8312 + ] + } + ], + "confidence": 0.9, + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "A123", + "content": "A123", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ] + } + ], + "confidence": 0.877, + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 2, + "content": "2", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 634, + "length": 1 + } + ] + }, + "Tax": { + "type": "number", + "content": "10%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ] + } + ], + "confidence": 0.78, + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + "Unit": { + "type": "string", + "valueString": "hours", + "content": "hours", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 30, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ] + } + ], + "confidence": 0.828, + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + } + }, + "content": "3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8312, + 0.592, + 5.8312 + ] + } + ], + "confidence": 0.955, + "spans": [ + { + "offset": 600, + "length": 59 + } + ] + }, + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 30, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ] + } + ], + "confidence": 0.916, + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-05", + "content": "3/5/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ] + } + ], + "confidence": 0.902, + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Document Fee", + "content": "Document Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.345, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 2.345, + 6.0997 + ] + } + ], + "confidence": 0.901, + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "B456", + "content": "B456", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ] + } + ], + "confidence": 0.886, + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 3, + "content": "3", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ] + } + ], + "confidence": 0.898, + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + "Tax": { + "type": "number", + "content": "5%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ] + } + ], + "confidence": 0.772, + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ] + } + ], + "confidence": 0.831, + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + } + }, + "content": "3/5/2021 B456 Document Fee 3 $10.00 5% $30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.121, + 0.592, + 6.121 + ] + } + ], + "confidence": 0.941, + "spans": [ + { + "offset": 660, + "length": 45 + } + ] + }, + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ] + } + ], + "confidence": 0.959, + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-06", + "content": "3/6/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ] + } + ], + "confidence": 0.903, + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Printing Fee", + "content": "Printing Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.345, + 6.2906, + 3.1351, + 6.2906, + 3.1351, + 6.4281, + 2.345, + 6.4281 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "C789", + "content": "C789", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ] + } + ], + "confidence": 0.898, + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 10, + "content": "10", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ] + } + ], + "confidence": 0.903, + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + "Tax": { + "type": "number", + "content": "20%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ] + } + ], + "confidence": 0.791, + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + "Unit": { + "type": "string", + "valueString": "pages", + "content": "pages", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 1, + "content": "$1.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ] + } + ], + "confidence": 0.829, + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + } + }, + "content": "3/6/2021 C789 Printing Fee 10 pages $1.00 20% $10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4281, + 0.592, + 6.4281 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 706, + "length": 52 + } + ] + } + ] + }, + "Locale": { + "type": "string", + "valueString": "en-US", + "confidence": 1 + }, + "PreviousUnpaidBalance": { + "type": "number", + "valueNumber": 500, + "content": "$500.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ] + } + ], + "confidence": 0.962, + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + "PurchaseOrder": { + "type": "string", + "valueString": "PO-3333", + "content": "PO-3333", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ] + } + ], + "confidence": 0.967, + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + "RemittanceAddress": { + "type": "string", + "valueString": "123 Remit St New York, NY, 10001", + "content": "123 Remit St New York, NY, 10001", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 9.5717, + 1.9882, + 9.5717, + 1.9882, + 9.9098, + 0.5943, + 9.9098 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 913, + "length": 32 + } + ] + }, + "RemittanceAddressRecipient": { + "type": "string", + "valueString": "Contoso Billing", + "content": "Contoso Billing", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5882, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 0.5882, + 9.5059 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 897, + "length": 15 + } + ] + }, + "ServiceAddress": { + "type": "string", + "valueString": "123 Service St, Redmond WA, 98052", + "content": "123 Service St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2197, + 3.9734, + 7.6337, + 3.9734, + 7.6337, + 4.3082, + 6.2197, + 4.3082 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 402, + "length": 15 + }, + { + "offset": 454, + "length": 17 + } + ] + }, + "ServiceAddressRecipient": { + "type": "string", + "valueString": "Microsoft Services", + "content": "Microsoft Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2197, + 3.7641, + 7.4427, + 3.7641, + 7.4427, + 3.8794, + 6.2197, + 3.8794 + ] + } + ], + "confidence": 0.951, + "spans": [ + { + "offset": 357, + "length": 18 + } + ] + }, + "ServiceEndDate": { + "type": "date", + "valueDate": "2019-11-14", + "content": "11/14/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2528, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 7.2528, + 2.3615 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 204, + "length": 10 + } + ] + }, + "ServiceStartDate": { + "type": "date", + "valueDate": "2019-10-14", + "content": "10/14/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.3357, + 2.2306, + 7.0749, + 2.2306, + 7.0749, + 2.3615, + 6.3357, + 2.3615 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 191, + "length": 10 + } + ] + }, + "ShippingAddress": { + "type": "string", + "valueString": "123 Ship St, Redmond WA, 98052", + "content": "123 Ship St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3454, + 3.9681, + 4.7594, + 3.9681, + 4.7594, + 4.3082, + 3.3454, + 4.3082 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 389, + "length": 12 + }, + { + "offset": 436, + "length": 17 + } + ] + }, + "ShippingAddressRecipient": { + "type": "string", + "valueString": "Microsoft Delivery", + "content": "Microsoft Delivery", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3454, + 3.7641, + 4.5762, + 3.7641, + 4.5762, + 3.9076, + 3.3454, + 3.9076 + ] + } + ], + "confidence": 0.955, + "spans": [ + { + "offset": 338, + "length": 18 + } + ] + }, + "SubTotal": { + "type": "number", + "valueNumber": 100, + "content": "$100.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + "TotalTax": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + "VendorAddress": { + "type": "string", + "valueString": "123 456th St New York, NY, 10001", + "content": "123 456th St New York, NY, 10001", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 1.6092, + 1.9894, + 1.6092, + 1.9894, + 1.9675, + 0.5943, + 1.9675 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 59, + "length": 12 + }, + { + "offset": 97, + "length": 19 + } + ] + }, + "VendorAddressRecipient": { + "type": "string", + "valueString": "Contoso Headquarters", + "content": "Contoso Headquarters", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5882, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 0.5882, + 1.5664 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 21, + "length": 20 + } + ] + }, + "VendorName": { + "type": "string", + "valueString": "CONTOSO LTD.", + "content": "CONTOSO LTD.", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5911, + 0.6857, + 2.3181, + 0.6857, + 2.3181, + 0.8664, + 0.5911, + 0.8664 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 0, + "length": 12 + } + ] + } + }, + "confidence": 1, + "spans": [ + { + "offset": 0, + "length": 958 + } + ] + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Custom.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Custom.json index e130cd0fd1c9..8350f83fabc6 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Custom.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Custom.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "{customModelId}" - }, - "responses": { - "200": { - "body": { - "modelId": "{customModelId}", - "description": "{customModelDescription}", - "createdDateTime": "2021-09-24T12:54:35Z", - "apiVersion": "{apiVersion}", - "docTypes": { - "{docType}": { - "fieldSchema": { - "Name": { - "type": "string" - }, - "Date": { - "type": "date" - }, - "Amount": { - "type": "number" - } - }, - "buildMode": "template", - "fieldConfidence": { - "Name": 0.9, - "Date": 0.95, - "Amount": 0.93 - } - } - }, - "tags": { - "createdBy": "{userId}" - } - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "{customModelId}" + }, + "responses": { + "200": { + "body": { + "modelId": "{customModelId}", + "description": "{customModelDescription}", + "createdDateTime": "2021-09-24T12:54:35Z", + "apiVersion": "{apiVersion}", + "docTypes": { + "{docType}": { + "fieldSchema": { + "Name": { + "type": "string" + }, + "Date": { + "type": "date" + }, + "Amount": { + "type": "number" + } + }, + "buildMode": "template", + "fieldConfidence": { + "Name": 0.9, + "Date": 0.95, + "Amount": 0.93 + } + } + }, + "tags": { + "createdBy": "{userId}" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Prebuilt.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Prebuilt.json index e38e01d17d95..07c306345099 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Prebuilt.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModel_Prebuilt.json @@ -1,134 +1,134 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "modelId": "prebuilt-invoice" - }, - "responses": { - "200": { - "body": { - "modelId": "prebuilt-invoice", - "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.", - "createdDateTime": "2021-07-30T00:00:00Z", - "apiVersion": "{apiVersion}", - "docTypes": { - "prebuilt:invoice": { - "fieldSchema": { - "CustomerName": { - "type": "string" - }, - "CustomerId": { - "type": "string" - }, - "PurchaseOrder": { - "type": "string" - }, - "InvoiceId": { - "type": "string" - }, - "InvoiceDate": { - "type": "date" - }, - "DueDate": { - "type": "date" - }, - "VendorName": { - "type": "string" - }, - "VendorAddress": { - "type": "string" - }, - "VendorAddressRecipient": { - "type": "string" - }, - "CustomerAddress": { - "type": "string" - }, - "CustomerAddressRecipient": { - "type": "string" - }, - "BillingAddress": { - "type": "string" - }, - "BillingAddressRecipient": { - "type": "string" - }, - "ShippingAddress": { - "type": "string" - }, - "ShippingAddressRecipient": { - "type": "string" - }, - "SubTotal": { - "type": "number" - }, - "TotalTax": { - "type": "number" - }, - "InvoiceTotal": { - "type": "number" - }, - "AmountDue": { - "type": "number" - }, - "PreviousUnpaidBalance": { - "type": "number" - }, - "RemittanceAddress": { - "type": "string" - }, - "RemittanceAddressRecipient": { - "type": "string" - }, - "ServiceAddress": { - "type": "string" - }, - "ServiceAddressRecipient": { - "type": "string" - }, - "ServiceStartDate": { - "type": "date" - }, - "ServiceEndDate": { - "type": "date" - }, - "Items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Amount": { - "type": "number" - }, - "Date": { - "type": "date" - }, - "Description": { - "type": "string" - }, - "Quantity": { - "type": "number" - }, - "ProductCode": { - "type": "string" - }, - "Tax": { - "type": "number" - }, - "Unit": { - "type": "string" - }, - "UnitPrice": { - "type": "number" - } - } - } - } - } - } - }, - "tags": {} - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "modelId": "prebuilt-invoice" + }, + "responses": { + "200": { + "body": { + "modelId": "prebuilt-invoice", + "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.", + "createdDateTime": "2021-07-30T00:00:00Z", + "apiVersion": "{apiVersion}", + "docTypes": { + "prebuilt:invoice": { + "fieldSchema": { + "CustomerName": { + "type": "string" + }, + "CustomerId": { + "type": "string" + }, + "PurchaseOrder": { + "type": "string" + }, + "InvoiceId": { + "type": "string" + }, + "InvoiceDate": { + "type": "date" + }, + "DueDate": { + "type": "date" + }, + "VendorName": { + "type": "string" + }, + "VendorAddress": { + "type": "string" + }, + "VendorAddressRecipient": { + "type": "string" + }, + "CustomerAddress": { + "type": "string" + }, + "CustomerAddressRecipient": { + "type": "string" + }, + "BillingAddress": { + "type": "string" + }, + "BillingAddressRecipient": { + "type": "string" + }, + "ShippingAddress": { + "type": "string" + }, + "ShippingAddressRecipient": { + "type": "string" + }, + "SubTotal": { + "type": "number" + }, + "TotalTax": { + "type": "number" + }, + "InvoiceTotal": { + "type": "number" + }, + "AmountDue": { + "type": "number" + }, + "PreviousUnpaidBalance": { + "type": "number" + }, + "RemittanceAddress": { + "type": "string" + }, + "RemittanceAddressRecipient": { + "type": "string" + }, + "ServiceAddress": { + "type": "string" + }, + "ServiceAddressRecipient": { + "type": "string" + }, + "ServiceStartDate": { + "type": "date" + }, + "ServiceEndDate": { + "type": "date" + }, + "Items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Amount": { + "type": "number" + }, + "Date": { + "type": "date" + }, + "Description": { + "type": "string" + }, + "Quantity": { + "type": "number" + }, + "ProductCode": { + "type": "string" + }, + "Tax": { + "type": "number" + }, + "Unit": { + "type": "string" + }, + "UnitPrice": { + "type": "number" + } + } + } + } + } + } + }, + "tags": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModels.json index 7b4a9548940a..f89f5668c685 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModels.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetDocumentModels.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "modelId": "prebuilt-layout", - "createdDateTime": "2021-07-30T00:00:00Z", - "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.", - "apiVersion": "{apiVersion}" - }, - { - "modelId": "myCustomModel", - "createdDateTime": "2021-09-24T12:54:35Z", - "description": "{modelDescription}", - "apiVersion": "{apiVersion}" - } - ], - "nextLink": "{nextLinkUrl}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "modelId": "prebuilt-layout", + "createdDateTime": "2021-07-30T00:00:00Z", + "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.", + "apiVersion": "{apiVersion}" + }, + { + "modelId": "myCustomModel", + "createdDateTime": "2021-09-24T12:54:35Z", + "description": "{modelDescription}", + "apiVersion": "{apiVersion}" + } + ], + "nextLink": "{nextLinkUrl}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperation.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperation.json index 5ae624b34b02..8f6cf4d66ee2 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperation.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperation.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}", - "operationId": "{operationId}" - }, - "responses": { - "200": { - "body": { - "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4", - "status": "succeeded", - "percentCompleted": 100, - "createdDateTime": "2021-09-23T09:12:57Z", - "lastUpdatedDateTime": "2021-09-23T09:13:01Z", - "kind": "documentModelBuild", - "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}", - "result": { - "modelId": "{customModelId}", - "description": "{customModelDescription}", - "createdDateTime": "2021-09-23T09:13:01Z", - "apiVersion": "{apiVersion}" - } - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}", + "operationId": "{operationId}" + }, + "responses": { + "200": { + "body": { + "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4", + "status": "succeeded", + "percentCompleted": 100, + "createdDateTime": "2021-09-23T09:12:57Z", + "lastUpdatedDateTime": "2021-09-23T09:13:01Z", + "kind": "documentModelBuild", + "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}", + "result": { + "modelId": "{customModelId}", + "description": "{customModelDescription}", + "createdDateTime": "2021-09-23T09:13:01Z", + "apiVersion": "{apiVersion}" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperations.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperations.json index a8ae318390d4..1b84de8f8ae0 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperations.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetOperations.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "operationId": "{operationId}", - "status": "running", - "percentCompleted": 0, - "createdDateTime": "2021-09-23T09:12:57Z", - "lastUpdatedDateTime": "2021-09-23T09:12:58Z", - "kind": "documentModelBuild", - "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}", - "apiVersion": "{apiVersion}" - } - ], - "nextLink": "{nextLinkUrl}" - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "operationId": "{operationId}", + "status": "running", + "percentCompleted": 0, + "createdDateTime": "2021-09-23T09:12:57Z", + "lastUpdatedDateTime": "2021-09-23T09:12:58Z", + "kind": "documentModelBuild", + "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}", + "apiVersion": "{apiVersion}" + } + ], + "nextLink": "{nextLinkUrl}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetResourceDetails.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetResourceDetails.json index eadbf9fba1ee..8134190378cf 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetResourceDetails.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2022-08-31/examples/GetResourceDetails.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "endpoint": "{endpoint}", - "api-version": "{apiVersion}" - }, - "responses": { - "200": { - "body": { - "customDocumentModels": { - "count": 2, - "limit": 13 - } - } - } - } -} +{ + "parameters": { + "endpoint": "{endpoint}", + "api-version": "{apiVersion}" + }, + "responses": { + "200": { + "body": { + "customDocumentModels": { + "count": 2, + "limit": 13 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Base64.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Base64.json index ee31006a8e8b..83f0976f3df9 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Base64.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Base64.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "prebuilt-layout", - "pages": "1-2,4", - "locale": "en-US", - "stringIndexType": "textElements", - "analyzeRequest": { - "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "prebuilt-layout", + "pages": "1-2,4", + "locale": "en-US", + "stringIndexType": "textElements", + "analyzeRequest": { + "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Url.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Url.json index f19a19d7380c..8cef6abd5ad6 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Url.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AnalyzeDocument_Url.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "customModel", - "pages": "1-2,4", - "locale": "en-US", - "stringIndexType": "textElements", - "analyzeRequest": { - "urlSource": "http://host.com/doc.pdf" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "customModel", + "pages": "1-2,4", + "locale": "en-US", + "stringIndexType": "textElements", + "analyzeRequest": { + "urlSource": "http://host.com/doc.pdf" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AuthorizeCopyDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AuthorizeCopyDocumentModel.json index abc3238d3042..f45b7bd99e33 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AuthorizeCopyDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/AuthorizeCopyDocumentModel.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "authorizeCopyRequest": { - "modelId": "targetModel", - "description": "Target model description" - } - }, - "responses": { - "200": { - "body": { - "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", - "targetResourceRegion": "targetResourceRegion", - "targetModelId": "targetModel", - "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", - "accessToken": "accessToken", - "expirationDateTime": "2021-09-23T09:12:54.552Z" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "authorizeCopyRequest": { + "modelId": "targetModel", + "description": "Target model description" + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", + "targetResourceRegion": "targetResourceRegion", + "targetModelId": "targetModel", + "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", + "accessToken": "accessToken", + "expirationDateTime": "2021-09-23T09:12:54.552Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentClassifier.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentClassifier.json index 31a98e22c204..aadc7c1306c1 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentClassifier.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentClassifier.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "buildRequest": { - "classifierId": "myClassifier", - "description": "Classifier description", - "docTypes": { - "formA": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formADocs/" - } - }, - "formB": { - "azureBlobFileListSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "fileList": "formB.jsonl" - } - } - } - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "buildRequest": { + "classifierId": "myClassifier", + "description": "Classifier description", + "docTypes": { + "formA": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formADocs/" + } + }, + "formB": { + "azureBlobFileListSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "fileList": "formB.jsonl" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentModel.json index a8c8c54ad5fc..11dc2026d613 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/BuildDocumentModel.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "buildRequest": { - "modelId": "myCustomModel", - "description": "Custom model description", - "buildMode": "template", - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "trainingDocs/" - }, - "tags": { - "createdBy": "myUserId" - } - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "buildRequest": { + "modelId": "myCustomModel", + "description": "Custom model description", + "buildMode": "template", + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "trainingDocs/" + }, + "tags": { + "createdBy": "myUserId" + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ClassifyDocument_Url.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ClassifyDocument_Url.json index 7261054e7d77..5449841997fb 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ClassifyDocument_Url.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ClassifyDocument_Url.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "classifierId": "classifierId", - "stringIndexType": "textElements", - "classifyRequest": { - "urlSource": "http://host.com/doc.pdf" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "classifierId": "classifierId", + "stringIndexType": "textElements", + "classifyRequest": { + "urlSource": "http://host.com/doc.pdf" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ComposeDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ComposeDocumentModel.json index 54edc3b548ed..850886de0339 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ComposeDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/ComposeDocumentModel.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "composeRequest": { - "modelId": "composedModel", - "description": "Composed model description", - "componentModels": [ - { - "modelId": "model1" - }, - { - "modelId": "model2" - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "composeRequest": { + "modelId": "composedModel", + "description": "Composed model description", + "componentModels": [ + { + "modelId": "model1" + }, + { + "modelId": "model2" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/CopyDocumentModelTo.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/CopyDocumentModelTo.json index 0207d79cbfed..c8a04f432f97 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/CopyDocumentModelTo.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/CopyDocumentModelTo.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "sourceModel", - "copyToRequest": { - "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", - "targetResourceRegion": "targetResourceRegion", - "targetModelId": "targetModel", - "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", - "accessToken": "accessToken", - "expirationDateTime": "2021-09-23T09:12:54.552Z" - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "sourceModel", + "copyToRequest": { + "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", + "targetResourceRegion": "targetResourceRegion", + "targetModelId": "targetModel", + "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/formrecognizer/documentModels/targetModel", + "accessToken": "accessToken", + "expirationDateTime": "2021-09-23T09:12:54.552Z" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentClassifier.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentClassifier.json index 8f958c3f6a6e..fe0cff431852 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentClassifier.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentClassifier.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "classifierId": "myClassifier" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "classifierId": "myClassifier" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentModel.json index fe2c6de5ba9d..0c2a7b7e7657 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentModel.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/DeleteDocumentModel.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "myCustomModel" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "myCustomModel" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetAnalyzeDocumentResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetAnalyzeDocumentResult.json index 8a4e6dd3b532..747759a4d301 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetAnalyzeDocumentResult.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetAnalyzeDocumentResult.json @@ -1,7219 +1,7219 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "prebuilt-invoice", - "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" - }, - "responses": { - "200": { - "body": { - "status": "succeeded", - "createdDateTime": "2021-09-24T13:00:46Z", - "lastUpdatedDateTime": "2021-09-24T13:00:49Z", - "analyzeResult": { - "apiVersion": "2023-07-31", - "modelId": "prebuilt-invoice", - "stringIndexType": "textElements", - "content": "CONTOSO LTD.\nINVOICE\nContoso Headquarters\nINVOICE: INV-100\n123 456th St\nINVOICE DATE: 11/15/2019\nNew York, NY, 10001\nDUE DATE: 12/15/2019\nCUSTOMER NAME: MICROSOFT CORPORATION\nSERVICE PERIOD: 10/14/2019 – 11/14/2019\nCUSTOMER ID: CID-12345\nMicrosoft Corp\n123 Other St,\nRedmond WA, 98052\nBILL TO:\nSHIP TO:\nSERVICE ADDRESS:\nMicrosoft Finance\nMicrosoft Delivery\nMicrosoft Services\n123 Bill St,\n123 Ship St,\n123 Service St,\nRedmond WA, 98052\nRedmond WA, 98052\nRedmond WA, 98052\nSALESPERSON\nP.O. NUMBER\nREQUISITIONER\nSHIPPED VIA\nF.O.B. POINT\nTERMS\nPO-3333\nDATE\nITEM CODE\nDESCRIPTION\nQTY\nUM\nPRICE\nTAX\nAMOUNT\n3/4/2021\nA123\nConsulting Services\n2\nhours\n$30.00\n10%\n$60.00\n3/5/2021\nB456\nDocument Fee\n3\n$10.00\n5%\n$30.00\n3/6/2021\nC789\nPrinting Fee\n10\npages\n$1.00\n20%\n$10.00\nSUBTOTAL\n$100.00\nSALES TAX\n$10.00\nTOTAL\n$110.00\nPREVIOUS UNPAID BALANCE\n$500.00\nAMOUNT DUE\n$610.00\nTHANK YOU FOR YOUR BUSINESS!\nREMIT TO:\nContoso Billing\n123 Remit St\nNew York, NY, 10001\n:unselected:", - "pages": [ - { - "pageNumber": 1, - "angle": 0, - "width": 8.5, - "height": 11, - "unit": "inch", - "words": [ - { - "content": "CONTOSO", - "polygon": [ - 0.5911, - 0.6857, - 1.7451, - 0.6857, - 1.7451, - 0.8664, - 0.5911, - 0.8664 - ], - "confidence": 1, - "span": { - "offset": 0, - "length": 7 - } - }, - { - "content": "LTD.", - "polygon": [ - 1.8441, - 0.6879, - 2.3181, - 0.6879, - 2.3181, - 0.865, - 1.8441, - 0.865 - ], - "confidence": 1, - "span": { - "offset": 8, - "length": 4 - } - }, - { - "content": "INVOICE", - "polygon": [ - 7.0751, - 0.589, - 7.9886, - 0.589, - 7.9886, - 0.7697, - 7.0751, - 0.7697 - ], - "confidence": 1, - "span": { - "offset": 13, - "length": 7 - } - }, - { - "content": "Contoso", - "polygon": [ - 0.5882, - 1.4303, - 1.1337, - 1.4303, - 1.1337, - 1.5383, - 0.5882, - 1.5383 - ], - "confidence": 1, - "span": { - "offset": 21, - "length": 7 - } - }, - { - "content": "Headquarters", - "polygon": [ - 1.1905, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 1.1905, - 1.5664 - ], - "confidence": 1, - "span": { - "offset": 29, - "length": 12 - } - }, - { - "content": "INVOICE:", - "polygon": [ - 6.8599, - 1.4217, - 7.4328, - 1.4217, - 7.4328, - 1.5218, - 6.8599, - 1.5218 - ], - "confidence": 1, - "span": { - "offset": 42, - "length": 8 - } - }, - { - "content": "INV-100", - "polygon": [ - 7.4959, - 1.422, - 7.9988, - 1.422, - 7.9988, - 1.5215, - 7.4959, - 1.5215 - ], - "confidence": 1, - "span": { - "offset": 51, - "length": 7 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 1.6339, - 0.8213, - 1.6339, - 0.8213, - 1.742, - 0.5945, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 59, - "length": 3 - } - }, - { - "content": "456th", - "polygon": [ - 0.874, - 1.6092, - 1.2102, - 1.6092, - 1.2102, - 1.742, - 0.874, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 63, - "length": 5 - } - }, - { - "content": "St", - "polygon": [ - 1.2598, - 1.6339, - 1.3812, - 1.6339, - 1.3812, - 1.742, - 1.2598, - 1.742 - ], - "confidence": 1, - "span": { - "offset": 69, - "length": 2 - } - }, - { - "content": "INVOICE", - "polygon": [ - 6.2263, - 1.6254, - 6.7562, - 1.6254, - 6.7562, - 1.7256, - 6.2263, - 1.7256 - ], - "confidence": 1, - "span": { - "offset": 72, - "length": 7 - } - }, - { - "content": "DATE:", - "polygon": [ - 6.8132, - 1.6267, - 7.1891, - 1.6267, - 7.1891, - 1.7248, - 6.8132, - 1.7248 - ], - "confidence": 1, - "span": { - "offset": 80, - "length": 5 - } - }, - { - "content": "11/15/2019", - "polygon": [ - 7.2528, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 7.2528, - 1.7449 - ], - "confidence": 1, - "span": { - "offset": 86, - "length": 10 - } - }, - { - "content": "New", - "polygon": [ - 0.5943, - 1.8385, - 0.8848, - 1.8385, - 0.8848, - 1.9454, - 0.5943, - 1.9454 - ], - "confidence": 1, - "span": { - "offset": 97, - "length": 3 - } - }, - { - "content": "York,", - "polygon": [ - 0.9293, - 1.8307, - 1.2568, - 1.8307, - 1.2568, - 1.9675, - 0.9293, - 1.9675 - ], - "confidence": 1, - "span": { - "offset": 101, - "length": 5 - } - }, - { - "content": "NY,", - "polygon": [ - 1.3205, - 1.8382, - 1.5242, - 1.8382, - 1.5242, - 1.9675, - 1.3205, - 1.9675 - ], - "confidence": 1, - "span": { - "offset": 107, - "length": 3 - } - }, - { - "content": "10001", - "polygon": [ - 1.5915, - 1.8372, - 1.9894, - 1.8372, - 1.9894, - 1.9454, - 1.5915, - 1.9454 - ], - "confidence": 1, - "span": { - "offset": 111, - "length": 5 - } - }, - { - "content": "DUE", - "polygon": [ - 6.4966, - 1.8333, - 6.7569, - 1.8333, - 6.7569, - 1.9322, - 6.4966, - 1.9322 - ], - "confidence": 1, - "span": { - "offset": 117, - "length": 3 - } - }, - { - "content": "DATE:", - "polygon": [ - 6.8126, - 1.8333, - 7.1846, - 1.8333, - 7.1846, - 1.9315, - 6.8126, - 1.9315 - ], - "confidence": 1, - "span": { - "offset": 121, - "length": 5 - } - }, - { - "content": "12/15/2019", - "polygon": [ - 7.2494, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 7.2494, - 1.9515 - ], - "confidence": 1, - "span": { - "offset": 127, - "length": 10 - } - }, - { - "content": "CUSTOMER", - "polygon": [ - 4.9513, - 2.0388, - 5.6868, - 2.0388, - 5.6868, - 2.1389, - 4.9513, - 2.1389 - ], - "confidence": 1, - "span": { - "offset": 138, - "length": 8 - } - }, - { - "content": "NAME:", - "polygon": [ - 5.7412, - 2.04, - 6.1764, - 2.04, - 6.1764, - 2.1381, - 5.7412, - 2.1381 - ], - "confidence": 1, - "span": { - "offset": 147, - "length": 5 - } - }, - { - "content": "MICROSOFT", - "polygon": [ - 6.2419, - 2.0391, - 6.9981, - 2.0391, - 6.9981, - 2.1386, - 6.2419, - 2.1386 - ], - "confidence": 1, - "span": { - "offset": 153, - "length": 9 - } - }, - { - "content": "CORPORATION", - "polygon": [ - 7.0448, - 2.0391, - 7.9825, - 2.0391, - 7.9825, - 2.1386, - 7.0448, - 2.1386 - ], - "confidence": 1, - "span": { - "offset": 163, - "length": 11 - } - }, - { - "content": "SERVICE", - "polygon": [ - 5.1667, - 2.2421, - 5.6923, - 2.2421, - 5.6923, - 2.3422, - 5.1667, - 2.3422 - ], - "confidence": 1, - "span": { - "offset": 175, - "length": 7 - } - }, - { - "content": "PERIOD:", - "polygon": [ - 5.748, - 2.2421, - 6.2721, - 2.2421, - 6.2721, - 2.3422, - 5.748, - 2.3422 - ], - "confidence": 1, - "span": { - "offset": 183, - "length": 7 - } - }, - { - "content": "10/14/2019", - "polygon": [ - 6.3357, - 2.2306, - 7.0749, - 2.2306, - 7.0749, - 2.3615, - 6.3357, - 2.3615 - ], - "confidence": 1, - "span": { - "offset": 191, - "length": 10 - } - }, - { - "content": "–", - "polygon": [ - 7.122, - 2.2922, - 7.1995, - 2.2922, - 7.1995, - 2.3037, - 7.122, - 2.3037 - ], - "confidence": 1, - "span": { - "offset": 202, - "length": 1 - } - }, - { - "content": "11/14/2019", - "polygon": [ - 7.2528, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 7.2528, - 2.3615 - ], - "confidence": 1, - "span": { - "offset": 204, - "length": 10 - } - }, - { - "content": "CUSTOMER", - "polygon": [ - 6.3253, - 2.4488, - 7.0608, - 2.4488, - 7.0608, - 2.5489, - 6.3253, - 2.5489 - ], - "confidence": 1, - "span": { - "offset": 215, - "length": 8 - } - }, - { - "content": "ID:", - "polygon": [ - 7.1153, - 2.45, - 7.2809, - 2.45, - 7.2809, - 2.5481, - 7.1153, - 2.5481 - ], - "confidence": 1, - "span": { - "offset": 224, - "length": 3 - } - }, - { - "content": "CID-12345", - "polygon": [ - 7.3369, - 2.4491, - 7.9951, - 2.4491, - 7.9951, - 2.5486, - 7.3369, - 2.5486 - ], - "confidence": 1, - "span": { - "offset": 228, - "length": 9 - } - }, - { - "content": "Microsoft", - "polygon": [ - 0.5943, - 2.6436, - 1.2303, - 2.6436, - 1.2303, - 2.759, - 0.5943, - 2.759 - ], - "confidence": 1, - "span": { - "offset": 238, - "length": 9 - } - }, - { - "content": "Corp", - "polygon": [ - 1.2808, - 2.651, - 1.586, - 2.651, - 1.586, - 2.7871, - 1.2808, - 2.7871 - ], - "confidence": 1, - "span": { - "offset": 248, - "length": 4 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 2.8541, - 0.8213, - 2.8541, - 0.8213, - 2.9623, - 0.5945, - 2.9623 - ], - "confidence": 1, - "span": { - "offset": 253, - "length": 3 - } - }, - { - "content": "Other", - "polygon": [ - 0.875, - 2.8476, - 1.262, - 2.8476, - 1.262, - 2.9623, - 0.875, - 2.9623 - ], - "confidence": 1, - "span": { - "offset": 257, - "length": 5 - } - }, - { - "content": "St,", - "polygon": [ - 1.3058, - 2.8541, - 1.4633, - 2.8541, - 1.4633, - 2.9845, - 1.3058, - 2.9845 - ], - "confidence": 1, - "span": { - "offset": 263, - "length": 3 - } - }, - { - "content": "Redmond", - "polygon": [ - 0.5943, - 3.0513, - 1.2222, - 3.0513, - 1.2222, - 3.1656, - 0.5943, - 3.1656 - ], - "confidence": 1, - "span": { - "offset": 267, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 1.2753, - 3.0585, - 1.5468, - 3.0585, - 1.5468, - 3.1878, - 1.2753, - 3.1878 - ], - "confidence": 1, - "span": { - "offset": 275, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 1.6033, - 3.0575, - 2.0083, - 3.0575, - 2.0083, - 3.1656, - 1.6033, - 3.1656 - ], - "confidence": 1, - "span": { - "offset": 279, - "length": 5 - } - }, - { - "content": "BILL", - "polygon": [ - 0.5909, - 3.5603, - 0.8438, - 3.5603, - 0.8438, - 3.6579, - 0.5909, - 3.6579 - ], - "confidence": 1, - "span": { - "offset": 285, - "length": 4 - } - }, - { - "content": "TO:", - "polygon": [ - 0.8846, - 3.559, - 1.1032, - 3.559, - 1.1032, - 3.6592, - 0.8846, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 290, - "length": 3 - } - }, - { - "content": "SHIP", - "polygon": [ - 3.3361, - 3.559, - 3.6278, - 3.559, - 3.6278, - 3.6592, - 3.3361, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 294, - "length": 4 - } - }, - { - "content": "TO:", - "polygon": [ - 3.6716, - 3.559, - 3.8903, - 3.559, - 3.8903, - 3.6592, - 3.6716, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 299, - "length": 3 - } - }, - { - "content": "SERVICE", - "polygon": [ - 6.2104, - 3.559, - 6.7361, - 3.559, - 6.7361, - 3.6592, - 6.2104, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 303, - "length": 7 - } - }, - { - "content": "ADDRESS:", - "polygon": [ - 6.7828, - 3.559, - 7.4232, - 3.559, - 7.4232, - 3.6592, - 6.7828, - 3.6592 - ], - "confidence": 1, - "span": { - "offset": 311, - "length": 8 - } - }, - { - "content": "Microsoft", - "polygon": [ - 0.5943, - 3.7641, - 1.2303, - 3.7641, - 1.2303, - 3.8794, - 0.5943, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 320, - "length": 9 - } - }, - { - "content": "Finance", - "polygon": [ - 1.287, - 3.7701, - 1.7878, - 3.7701, - 1.7878, - 3.8794, - 1.287, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 330, - "length": 7 - } - }, - { - "content": "Microsoft", - "polygon": [ - 3.3454, - 3.7641, - 3.9814, - 3.7641, - 3.9814, - 3.8794, - 3.3454, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 338, - "length": 9 - } - }, - { - "content": "Delivery", - "polygon": [ - 4.0381, - 3.7647, - 4.5762, - 3.7647, - 4.5762, - 3.9076, - 4.0381, - 3.9076 - ], - "confidence": 1, - "span": { - "offset": 348, - "length": 8 - } - }, - { - "content": "Microsoft", - "polygon": [ - 6.2197, - 3.7641, - 6.8557, - 3.7641, - 6.8557, - 3.8794, - 6.2197, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 357, - "length": 9 - } - }, - { - "content": "Services", - "polygon": [ - 6.9042, - 3.7701, - 7.4427, - 3.7701, - 7.4427, - 3.8794, - 6.9042, - 3.8794 - ], - "confidence": 1, - "span": { - "offset": 367, - "length": 8 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 3.9746, - 0.8213, - 3.9746, - 0.8213, - 4.0827, - 0.5945, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 376, - "length": 3 - } - }, - { - "content": "Bill", - "polygon": [ - 0.8842, - 3.9681, - 1.0657, - 3.9681, - 1.0657, - 4.0817, - 0.8842, - 4.0817 - ], - "confidence": 1, - "span": { - "offset": 380, - "length": 4 - } - }, - { - "content": "St,", - "polygon": [ - 1.1222, - 3.9746, - 1.2765, - 3.9746, - 1.2765, - 4.1049, - 1.1222, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 385, - "length": 3 - } - }, - { - "content": "123", - "polygon": [ - 3.3456, - 3.9746, - 3.5724, - 3.9746, - 3.5724, - 4.0827, - 3.3456, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 389, - "length": 3 - } - }, - { - "content": "Ship", - "polygon": [ - 3.6239, - 3.9681, - 3.9042, - 3.9681, - 3.9042, - 4.1109, - 3.6239, - 4.1109 - ], - "confidence": 1, - "span": { - "offset": 393, - "length": 4 - } - }, - { - "content": "St,", - "polygon": [ - 3.9536, - 3.9746, - 4.1111, - 3.9746, - 4.1111, - 4.1049, - 3.9536, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 398, - "length": 3 - } - }, - { - "content": "123", - "polygon": [ - 6.2199, - 3.9746, - 6.4467, - 3.9746, - 6.4467, - 4.0827, - 6.2199, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 402, - "length": 3 - } - }, - { - "content": "Service", - "polygon": [ - 6.4985, - 3.9734, - 6.9738, - 3.9734, - 6.9738, - 4.0827, - 6.4985, - 4.0827 - ], - "confidence": 1, - "span": { - "offset": 406, - "length": 7 - } - }, - { - "content": "St,", - "polygon": [ - 7.0246, - 3.9746, - 7.1821, - 3.9746, - 7.1821, - 4.1049, - 7.0246, - 4.1049 - ], - "confidence": 1, - "span": { - "offset": 414, - "length": 3 - } - }, - { - "content": "Redmond", - "polygon": [ - 0.5943, - 4.1717, - 1.2222, - 4.1717, - 1.2222, - 4.2861, - 0.5943, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 418, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 1.2753, - 4.1789, - 1.5468, - 4.1789, - 1.5468, - 4.3082, - 1.2753, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 426, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 1.6033, - 4.1779, - 2.0083, - 4.1779, - 2.0083, - 4.2861, - 1.6033, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 430, - "length": 5 - } - }, - { - "content": "Redmond", - "polygon": [ - 3.3454, - 4.1717, - 3.9732, - 4.1717, - 3.9732, - 4.2861, - 3.3454, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 436, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 4.0264, - 4.1789, - 4.2979, - 4.1789, - 4.2979, - 4.3082, - 4.0264, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 444, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 4.3544, - 4.1779, - 4.7594, - 4.1779, - 4.7594, - 4.2861, - 4.3544, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 448, - "length": 5 - } - }, - { - "content": "Redmond", - "polygon": [ - 6.2197, - 4.1717, - 6.8475, - 4.1717, - 6.8475, - 4.2861, - 6.2197, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 454, - "length": 7 - } - }, - { - "content": "WA,", - "polygon": [ - 6.9007, - 4.1789, - 7.1722, - 4.1789, - 7.1722, - 4.3082, - 6.9007, - 4.3082 - ], - "confidence": 1, - "span": { - "offset": 462, - "length": 3 - } - }, - { - "content": "98052", - "polygon": [ - 7.2287, - 4.1779, - 7.6337, - 4.1779, - 7.6337, - 4.2861, - 7.2287, - 4.2861 - ], - "confidence": 1, - "span": { - "offset": 466, - "length": 5 - } - }, - { - "content": "SALESPERSON", - "polygon": [ - 0.7018, - 4.6528, - 1.6092, - 4.6528, - 1.6092, - 4.7529, - 0.7018, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 472, - "length": 11 - } - }, - { - "content": "P.O.", - "polygon": [ - 2.1216, - 4.6528, - 2.3788, - 4.6528, - 2.3788, - 4.7529, - 2.1216, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 484, - "length": 4 - } - }, - { - "content": "NUMBER", - "polygon": [ - 2.4376, - 4.654, - 3.0155, - 4.654, - 3.0155, - 4.7529, - 2.4376, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 489, - "length": 6 - } - }, - { - "content": "REQUISITIONER", - "polygon": [ - 3.4953, - 4.6528, - 4.5157, - 4.6528, - 4.5157, - 4.7687, - 3.4953, - 4.7687 - ], - "confidence": 1, - "span": { - "offset": 496, - "length": 13 - } - }, - { - "content": "SHIPPED", - "polygon": [ - 4.81, - 4.6528, - 5.362, - 4.6528, - 5.362, - 4.7529, - 4.81, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 510, - "length": 7 - } - }, - { - "content": "VIA", - "polygon": [ - 5.409, - 4.654, - 5.6317, - 4.654, - 5.6317, - 4.7517, - 5.409, - 4.7517 - ], - "confidence": 1, - "span": { - "offset": 518, - "length": 3 - } - }, - { - "content": "F.O.B.", - "polygon": [ - 5.8696, - 4.6528, - 6.2467, - 4.6528, - 6.2467, - 4.7529, - 5.8696, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 522, - "length": 6 - } - }, - { - "content": "POINT", - "polygon": [ - 6.3054, - 4.6528, - 6.706, - 4.6528, - 6.706, - 4.7529, - 6.3054, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 529, - "length": 5 - } - }, - { - "content": "TERMS", - "polygon": [ - 7.1806, - 4.6528, - 7.6304, - 4.6528, - 7.6304, - 4.7529, - 7.1806, - 4.7529 - ], - "confidence": 1, - "span": { - "offset": 535, - "length": 5 - } - }, - { - "content": "PO-3333", - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ], - "confidence": 1, - "span": { - "offset": 541, - "length": 7 - } - }, - { - "content": "DATE", - "polygon": [ - 0.7409, - 5.421, - 1.0744, - 5.421, - 1.0744, - 5.5186, - 0.7409, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 549, - "length": 4 - } - }, - { - "content": "ITEM", - "polygon": [ - 1.4213, - 5.421, - 1.7338, - 5.421, - 1.7338, - 5.5186, - 1.4213, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 554, - "length": 4 - } - }, - { - "content": "CODE", - "polygon": [ - 1.7893, - 5.4197, - 2.1407, - 5.4197, - 2.1407, - 5.5199, - 1.7893, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 559, - "length": 4 - } - }, - { - "content": "DESCRIPTION", - "polygon": [ - 2.8516, - 5.4197, - 3.7134, - 5.4197, - 3.7134, - 5.5199, - 2.8516, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 564, - "length": 11 - } - }, - { - "content": "QTY", - "polygon": [ - 4.4043, - 5.4197, - 4.6631, - 5.4197, - 4.6631, - 5.5357, - 4.4043, - 5.5357 - ], - "confidence": 1, - "span": { - "offset": 576, - "length": 3 - } - }, - { - "content": "UM", - "polygon": [ - 5.049, - 5.421, - 5.2654, - 5.421, - 5.2654, - 5.5199, - 5.049, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 580, - "length": 2 - } - }, - { - "content": "PRICE", - "polygon": [ - 5.8563, - 5.4199, - 6.2163, - 5.4199, - 6.2163, - 5.5197, - 5.8563, - 5.5197 - ], - "confidence": 1, - "span": { - "offset": 583, - "length": 5 - } - }, - { - "content": "TAX", - "polygon": [ - 6.7169, - 5.421, - 6.974, - 5.421, - 6.974, - 5.5186, - 6.7169, - 5.5186 - ], - "confidence": 1, - "span": { - "offset": 589, - "length": 3 - } - }, - { - "content": "AMOUNT", - "polygon": [ - 7.2847, - 5.4197, - 7.9039, - 5.4197, - 7.9039, - 5.5199, - 7.2847, - 5.5199 - ], - "confidence": 1, - "span": { - "offset": 593, - "length": 6 - } - }, - { - "content": "3/4/2021", - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ], - "confidence": 1, - "span": { - "offset": 600, - "length": 8 - } - }, - { - "content": "A123", - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 609, - "length": 4 - } - }, - { - "content": "Consulting", - "polygon": [ - 2.3388, - 5.6883, - 3.0438, - 5.6883, - 3.0438, - 5.8312, - 2.3388, - 5.8312 - ], - "confidence": 1, - "span": { - "offset": 614, - "length": 10 - } - }, - { - "content": "Services", - "polygon": [ - 3.0925, - 5.6937, - 3.6278, - 5.6937, - 3.6278, - 5.803, - 3.0925, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 625, - "length": 8 - } - }, - { - "content": "2", - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ], - "confidence": 1, - "span": { - "offset": 634, - "length": 1 - } - }, - { - "content": "hours", - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ], - "confidence": 1, - "span": { - "offset": 636, - "length": 5 - } - }, - { - "content": "$30.00", - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ], - "confidence": 1, - "span": { - "offset": 642, - "length": 6 - } - }, - { - "content": "10%", - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ], - "confidence": 1, - "span": { - "offset": 649, - "length": 3 - } - }, - { - "content": "$60.00", - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ], - "confidence": 1, - "span": { - "offset": 653, - "length": 6 - } - }, - { - "content": "3/5/2021", - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ], - "confidence": 1, - "span": { - "offset": 660, - "length": 8 - } - }, - { - "content": "B456", - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 669, - "length": 4 - } - }, - { - "content": "Document", - "polygon": [ - 2.345, - 5.993, - 3.0318, - 5.993, - 3.0318, - 6.0997, - 2.345, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 674, - "length": 8 - } - }, - { - "content": "Fee", - "polygon": [ - 3.0887, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 3.0887, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 683, - "length": 3 - } - }, - { - "content": "3", - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ], - "confidence": 1, - "span": { - "offset": 687, - "length": 1 - } - }, - { - "content": "$10.00", - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ], - "confidence": 1, - "span": { - "offset": 689, - "length": 6 - } - }, - { - "content": "5%", - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ], - "confidence": 1, - "span": { - "offset": 696, - "length": 2 - } - }, - { - "content": "$30.00", - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ], - "confidence": 1, - "span": { - "offset": 699, - "length": 6 - } - }, - { - "content": "3/6/2021", - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ], - "confidence": 1, - "span": { - "offset": 706, - "length": 8 - } - }, - { - "content": "C789", - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 715, - "length": 4 - } - }, - { - "content": "Printing", - "polygon": [ - 2.345, - 6.2906, - 2.8575, - 6.2906, - 2.8575, - 6.4281, - 2.345, - 6.4281 - ], - "confidence": 1, - "span": { - "offset": 720, - "length": 8 - } - }, - { - "content": "Fee", - "polygon": [ - 2.9143, - 6.2933, - 3.1351, - 6.2933, - 3.1351, - 6.3999, - 2.9143, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 729, - "length": 3 - } - }, - { - "content": "10", - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ], - "confidence": 1, - "span": { - "offset": 733, - "length": 2 - } - }, - { - "content": "pages", - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ], - "confidence": 1, - "span": { - "offset": 736, - "length": 5 - } - }, - { - "content": "$1.00", - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ], - "confidence": 1, - "span": { - "offset": 742, - "length": 5 - } - }, - { - "content": "20%", - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ], - "confidence": 1, - "span": { - "offset": 748, - "length": 3 - } - }, - { - "content": "$10.00", - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ], - "confidence": 1, - "span": { - "offset": 752, - "length": 6 - } - }, - { - "content": "SUBTOTAL", - "polygon": [ - 6.0282, - 6.9118, - 6.7309, - 6.9118, - 6.7309, - 7.0199, - 6.0282, - 7.0199 - ], - "confidence": 1, - "span": { - "offset": 759, - "length": 8 - } - }, - { - "content": "$100.00", - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ], - "confidence": 1, - "span": { - "offset": 768, - "length": 7 - } - }, - { - "content": "SALES", - "polygon": [ - 6.0382, - 7.2089, - 6.4262, - 7.2089, - 6.4262, - 7.317, - 6.0382, - 7.317 - ], - "confidence": 1, - "span": { - "offset": 776, - "length": 5 - } - }, - { - "content": "TAX", - "polygon": [ - 6.4702, - 7.2099, - 6.728, - 7.2099, - 6.728, - 7.316, - 6.4702, - 7.316 - ], - "confidence": 1, - "span": { - "offset": 782, - "length": 3 - } - }, - { - "content": "$10.00", - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ], - "confidence": 1, - "span": { - "offset": 786, - "length": 6 - } - }, - { - "content": "TOTAL", - "polygon": [ - 6.2969, - 7.5089, - 6.7309, - 7.5089, - 6.7309, - 7.617, - 6.2969, - 7.617 - ], - "confidence": 1, - "span": { - "offset": 793, - "length": 5 - } - }, - { - "content": "$110.00", - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ], - "confidence": 1, - "span": { - "offset": 799, - "length": 7 - } - }, - { - "content": "PREVIOUS", - "polygon": [ - 4.8126, - 7.8055, - 5.4789, - 7.8055, - 5.4789, - 7.9137, - 4.8126, - 7.9137 - ], - "confidence": 1, - "span": { - "offset": 807, - "length": 8 - } - }, - { - "content": "UNPAID", - "polygon": [ - 5.5362, - 7.8065, - 6.057, - 7.8065, - 6.057, - 7.9137, - 5.5362, - 7.9137 - ], - "confidence": 1, - "span": { - "offset": 816, - "length": 6 - } - }, - { - "content": "BALANCE", - "polygon": [ - 6.1164, - 7.8057, - 6.7249, - 7.8057, - 6.7249, - 7.9135, - 6.1164, - 7.9135 - ], - "confidence": 1, - "span": { - "offset": 823, - "length": 7 - } - }, - { - "content": "$500.00", - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ], - "confidence": 1, - "span": { - "offset": 831, - "length": 7 - } - }, - { - "content": "AMOUNT", - "polygon": [ - 5.7652, - 8.1022, - 6.4055, - 8.1022, - 6.4055, - 8.2104, - 5.7652, - 8.2104 - ], - "confidence": 1, - "span": { - "offset": 839, - "length": 6 - } - }, - { - "content": "DUE", - "polygon": [ - 6.4562, - 8.1032, - 6.725, - 8.1032, - 6.725, - 8.2104, - 6.4562, - 8.2104 - ], - "confidence": 1, - "span": { - "offset": 846, - "length": 3 - } - }, - { - "content": "$610.00", - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ], - "confidence": 1, - "span": { - "offset": 850, - "length": 7 - } - }, - { - "content": "THANK", - "polygon": [ - 3.129, - 8.5453, - 3.5887, - 8.5453, - 3.5887, - 8.6429, - 3.129, - 8.6429 - ], - "confidence": 1, - "span": { - "offset": 858, - "length": 5 - } - }, - { - "content": "YOU", - "polygon": [ - 3.6316, - 8.544, - 3.9064, - 8.544, - 3.9064, - 8.6442, - 3.6316, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 864, - "length": 3 - } - }, - { - "content": "FOR", - "polygon": [ - 3.9671, - 8.544, - 4.2187, - 8.544, - 4.2187, - 8.6442, - 3.9671, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 868, - "length": 3 - } - }, - { - "content": "YOUR", - "polygon": [ - 4.2638, - 8.544, - 4.6347, - 8.544, - 4.6347, - 8.6442, - 4.2638, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 872, - "length": 4 - } - }, - { - "content": "BUSINESS!", - "polygon": [ - 4.6859, - 8.539, - 5.356, - 8.539, - 5.356, - 8.6442, - 4.6859, - 8.6442 - ], - "confidence": 1, - "span": { - "offset": 877, - "length": 9 - } - }, - { - "content": "REMIT", - "polygon": [ - 0.5909, - 9.1619, - 1.0014, - 9.1619, - 1.0014, - 9.2596, - 0.5909, - 9.2596 - ], - "confidence": 1, - "span": { - "offset": 887, - "length": 5 - } - }, - { - "content": "TO:", - "polygon": [ - 1.0446, - 9.1607, - 1.2603, - 9.1607, - 1.2603, - 9.2608, - 1.0446, - 9.2608 - ], - "confidence": 1, - "span": { - "offset": 893, - "length": 3 - } - }, - { - "content": "Contoso", - "polygon": [ - 0.5882, - 9.3697, - 1.1337, - 9.3697, - 1.1337, - 9.4777, - 0.5882, - 9.4777 - ], - "confidence": 1, - "span": { - "offset": 897, - "length": 7 - } - }, - { - "content": "Billing", - "polygon": [ - 1.1905, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 1.1905, - 9.5059 - ], - "confidence": 1, - "span": { - "offset": 905, - "length": 7 - } - }, - { - "content": "123", - "polygon": [ - 0.5945, - 9.5728, - 0.8213, - 9.5728, - 0.8213, - 9.681, - 0.5945, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 913, - "length": 3 - } - }, - { - "content": "Remit", - "polygon": [ - 0.881, - 9.5717, - 1.264, - 9.5717, - 1.264, - 9.681, - 0.881, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 917, - "length": 5 - } - }, - { - "content": "St", - "polygon": [ - 1.3125, - 9.5728, - 1.4337, - 9.5728, - 1.4337, - 9.681, - 1.3125, - 9.681 - ], - "confidence": 1, - "span": { - "offset": 923, - "length": 2 - } - }, - { - "content": "New", - "polygon": [ - 0.5943, - 9.7808, - 0.8848, - 9.7808, - 0.8848, - 9.8877, - 0.5943, - 9.8877 - ], - "confidence": 1, - "span": { - "offset": 926, - "length": 3 - } - }, - { - "content": "York,", - "polygon": [ - 0.9293, - 9.773, - 1.2568, - 9.773, - 1.2568, - 9.9098, - 0.9293, - 9.9098 - ], - "confidence": 1, - "span": { - "offset": 930, - "length": 5 - } - }, - { - "content": "NY,", - "polygon": [ - 1.3205, - 9.7805, - 1.5233, - 9.7805, - 1.5233, - 9.9098, - 1.3205, - 9.9098 - ], - "confidence": 1, - "span": { - "offset": 936, - "length": 3 - } - }, - { - "content": "10001", - "polygon": [ - 1.5903, - 9.7795, - 1.9882, - 9.7795, - 1.9882, - 9.8877, - 1.5903, - 9.8877 - ], - "confidence": 1, - "span": { - "offset": 940, - "length": 5 - } - } - ], - "selectionMarks": [ - { - "state": "unselected", - "polygon": [ - 4.3231, - 5.6279, - 4.7562, - 5.6279, - 4.7562, - 5.8654, - 4.3231, - 5.8654 - ], - "confidence": 0.212, - "span": { - "offset": 946, - "length": 12 - } - } - ], - "lines": [ - { - "content": "CONTOSO LTD.", - "polygon": [ - 0.5911, - 0.6857, - 2.3181, - 0.6857, - 2.3181, - 0.8664, - 0.5911, - 0.8664 - ], - "spans": [ - { - "offset": 0, - "length": 12 - } - ] - }, - { - "content": "INVOICE", - "polygon": [ - 7.0751, - 0.589, - 7.9886, - 0.589, - 7.9886, - 0.7697, - 7.0751, - 0.7697 - ], - "spans": [ - { - "offset": 13, - "length": 7 - } - ] - }, - { - "content": "Contoso Headquarters", - "polygon": [ - 0.5882, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 0.5882, - 1.5664 - ], - "spans": [ - { - "offset": 21, - "length": 20 - } - ] - }, - { - "content": "INVOICE: INV-100", - "polygon": [ - 6.8599, - 1.4217, - 7.9988, - 1.4217, - 7.9988, - 1.5218, - 6.8599, - 1.5218 - ], - "spans": [ - { - "offset": 42, - "length": 16 - } - ] - }, - { - "content": "123 456th St", - "polygon": [ - 0.5945, - 1.6092, - 1.3812, - 1.6092, - 1.3812, - 1.742, - 0.5945, - 1.742 - ], - "spans": [ - { - "offset": 59, - "length": 12 - } - ] - }, - { - "content": "INVOICE DATE: 11/15/2019", - "polygon": [ - 6.2263, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 6.2263, - 1.7449 - ], - "spans": [ - { - "offset": 72, - "length": 24 - } - ] - }, - { - "content": "New York, NY, 10001", - "polygon": [ - 0.5943, - 1.8307, - 1.9894, - 1.8307, - 1.9894, - 1.9675, - 0.5943, - 1.9675 - ], - "spans": [ - { - "offset": 97, - "length": 19 - } - ] - }, - { - "content": "DUE DATE: 12/15/2019", - "polygon": [ - 6.4966, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 6.4966, - 1.9515 - ], - "spans": [ - { - "offset": 117, - "length": 20 - } - ] - }, - { - "content": "CUSTOMER NAME: MICROSOFT CORPORATION", - "polygon": [ - 4.9513, - 2.0388, - 7.9825, - 2.0388, - 7.9825, - 2.1389, - 4.9513, - 2.1389 - ], - "spans": [ - { - "offset": 138, - "length": 36 - } - ] - }, - { - "content": "SERVICE PERIOD: 10/14/2019 – 11/14/2019", - "polygon": [ - 5.1667, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 5.1667, - 2.3615 - ], - "spans": [ - { - "offset": 175, - "length": 39 - } - ] - }, - { - "content": "CUSTOMER ID: CID-12345", - "polygon": [ - 6.3253, - 2.4488, - 7.9951, - 2.4488, - 7.9951, - 2.5489, - 6.3253, - 2.5489 - ], - "spans": [ - { - "offset": 215, - "length": 22 - } - ] - }, - { - "content": "Microsoft Corp", - "polygon": [ - 0.5943, - 2.6436, - 1.586, - 2.6436, - 1.586, - 2.7871, - 0.5943, - 2.7871 - ], - "spans": [ - { - "offset": 238, - "length": 14 - } - ] - }, - { - "content": "123 Other St,", - "polygon": [ - 0.5945, - 2.8476, - 1.4633, - 2.8476, - 1.4633, - 2.9845, - 0.5945, - 2.9845 - ], - "spans": [ - { - "offset": 253, - "length": 13 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 0.5943, - 3.0513, - 2.0083, - 3.0513, - 2.0083, - 3.1878, - 0.5943, - 3.1878 - ], - "spans": [ - { - "offset": 267, - "length": 17 - } - ] - }, - { - "content": "BILL TO:", - "polygon": [ - 0.5909, - 3.559, - 1.1032, - 3.559, - 1.1032, - 3.6592, - 0.5909, - 3.6592 - ], - "spans": [ - { - "offset": 285, - "length": 8 - } - ] - }, - { - "content": "SHIP TO:", - "polygon": [ - 3.3361, - 3.559, - 3.8903, - 3.559, - 3.8903, - 3.6592, - 3.3361, - 3.6592 - ], - "spans": [ - { - "offset": 294, - "length": 8 - } - ] - }, - { - "content": "SERVICE ADDRESS:", - "polygon": [ - 6.2104, - 3.559, - 7.4232, - 3.559, - 7.4232, - 3.6592, - 6.2104, - 3.6592 - ], - "spans": [ - { - "offset": 303, - "length": 16 - } - ] - }, - { - "content": "Microsoft Finance", - "polygon": [ - 0.5943, - 3.7641, - 1.7878, - 3.7641, - 1.7878, - 3.8794, - 0.5943, - 3.8794 - ], - "spans": [ - { - "offset": 320, - "length": 17 - } - ] - }, - { - "content": "Microsoft Delivery", - "polygon": [ - 3.3454, - 3.7641, - 4.5762, - 3.7641, - 4.5762, - 3.9076, - 3.3454, - 3.9076 - ], - "spans": [ - { - "offset": 338, - "length": 18 - } - ] - }, - { - "content": "Microsoft Services", - "polygon": [ - 6.2197, - 3.7641, - 7.4427, - 3.7641, - 7.4427, - 3.8794, - 6.2197, - 3.8794 - ], - "spans": [ - { - "offset": 357, - "length": 18 - } - ] - }, - { - "content": "123 Bill St,", - "polygon": [ - 0.5945, - 3.9681, - 1.2765, - 3.9681, - 1.2765, - 4.1049, - 0.5945, - 4.1049 - ], - "spans": [ - { - "offset": 376, - "length": 12 - } - ] - }, - { - "content": "123 Ship St,", - "polygon": [ - 3.3456, - 3.9681, - 4.1111, - 3.9681, - 4.1111, - 4.1109, - 3.3456, - 4.1109 - ], - "spans": [ - { - "offset": 389, - "length": 12 - } - ] - }, - { - "content": "123 Service St,", - "polygon": [ - 6.2199, - 3.9734, - 7.1821, - 3.9734, - 7.1821, - 4.1049, - 6.2199, - 4.1049 - ], - "spans": [ - { - "offset": 402, - "length": 15 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 0.5943, - 4.1717, - 2.0083, - 4.1717, - 2.0083, - 4.3082, - 0.5943, - 4.3082 - ], - "spans": [ - { - "offset": 418, - "length": 17 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 3.3454, - 4.1717, - 4.7594, - 4.1717, - 4.7594, - 4.3082, - 3.3454, - 4.3082 - ], - "spans": [ - { - "offset": 436, - "length": 17 - } - ] - }, - { - "content": "Redmond WA, 98052", - "polygon": [ - 6.2197, - 4.1717, - 7.6337, - 4.1717, - 7.6337, - 4.3082, - 6.2197, - 4.3082 - ], - "spans": [ - { - "offset": 454, - "length": 17 - } - ] - }, - { - "content": "SALESPERSON", - "polygon": [ - 0.7018, - 4.6528, - 1.6092, - 4.6528, - 1.6092, - 4.7529, - 0.7018, - 4.7529 - ], - "spans": [ - { - "offset": 472, - "length": 11 - } - ] - }, - { - "content": "P.O. NUMBER", - "polygon": [ - 2.1216, - 4.6528, - 3.0155, - 4.6528, - 3.0155, - 4.7529, - 2.1216, - 4.7529 - ], - "spans": [ - { - "offset": 484, - "length": 11 - } - ] - }, - { - "content": "REQUISITIONER", - "polygon": [ - 3.4953, - 4.6528, - 4.5157, - 4.6528, - 4.5157, - 4.7687, - 3.4953, - 4.7687 - ], - "spans": [ - { - "offset": 496, - "length": 13 - } - ] - }, - { - "content": "SHIPPED VIA", - "polygon": [ - 4.81, - 4.6528, - 5.6317, - 4.6528, - 5.6317, - 4.7529, - 4.81, - 4.7529 - ], - "spans": [ - { - "offset": 510, - "length": 11 - } - ] - }, - { - "content": "F.O.B. POINT", - "polygon": [ - 5.8696, - 4.6528, - 6.706, - 4.6528, - 6.706, - 4.7529, - 5.8696, - 4.7529 - ], - "spans": [ - { - "offset": 522, - "length": 12 - } - ] - }, - { - "content": "TERMS", - "polygon": [ - 7.1806, - 4.6528, - 7.6304, - 4.6528, - 7.6304, - 4.7529, - 7.1806, - 4.7529 - ], - "spans": [ - { - "offset": 535, - "length": 5 - } - ] - }, - { - "content": "PO-3333", - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ], - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - { - "content": "DATE", - "polygon": [ - 0.7409, - 5.421, - 1.0744, - 5.421, - 1.0744, - 5.5186, - 0.7409, - 5.5186 - ], - "spans": [ - { - "offset": 549, - "length": 4 - } - ] - }, - { - "content": "ITEM CODE", - "polygon": [ - 1.4213, - 5.4197, - 2.1407, - 5.4197, - 2.1407, - 5.5199, - 1.4213, - 5.5199 - ], - "spans": [ - { - "offset": 554, - "length": 9 - } - ] - }, - { - "content": "DESCRIPTION", - "polygon": [ - 2.8516, - 5.4197, - 3.7134, - 5.4197, - 3.7134, - 5.5199, - 2.8516, - 5.5199 - ], - "spans": [ - { - "offset": 564, - "length": 11 - } - ] - }, - { - "content": "QTY", - "polygon": [ - 4.4043, - 5.4197, - 4.6631, - 5.4197, - 4.6631, - 5.5357, - 4.4043, - 5.5357 - ], - "spans": [ - { - "offset": 576, - "length": 3 - } - ] - }, - { - "content": "UM", - "polygon": [ - 5.049, - 5.421, - 5.2654, - 5.421, - 5.2654, - 5.5199, - 5.049, - 5.5199 - ], - "spans": [ - { - "offset": 580, - "length": 2 - } - ] - }, - { - "content": "PRICE", - "polygon": [ - 5.8563, - 5.4199, - 6.2163, - 5.4199, - 6.2163, - 5.5197, - 5.8563, - 5.5197 - ], - "spans": [ - { - "offset": 583, - "length": 5 - } - ] - }, - { - "content": "TAX", - "polygon": [ - 6.7169, - 5.421, - 6.974, - 5.421, - 6.974, - 5.5186, - 6.7169, - 5.5186 - ], - "spans": [ - { - "offset": 589, - "length": 3 - } - ] - }, - { - "content": "AMOUNT", - "polygon": [ - 7.2847, - 5.4197, - 7.9039, - 5.4197, - 7.9039, - 5.5199, - 7.2847, - 5.5199 - ], - "spans": [ - { - "offset": 593, - "length": 6 - } - ] - }, - { - "content": "3/4/2021", - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ], - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - { - "content": "A123", - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ], - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - { - "content": "Consulting Services", - "polygon": [ - 2.3388, - 5.6883, - 3.6278, - 5.6883, - 3.6278, - 5.8312, - 2.3388, - 5.8312 - ], - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - { - "content": "2", - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ], - "spans": [ - { - "offset": 634, - "length": 1 - } - ] - }, - { - "content": "hours", - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ], - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - { - "content": "$30.00", - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ], - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - }, - { - "content": "10%", - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ], - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - { - "content": "$60.00", - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ], - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - { - "content": "3/5/2021", - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ], - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - { - "content": "B456", - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ], - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - { - "content": "Document Fee", - "polygon": [ - 2.345, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 2.345, - 6.0997 - ], - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - { - "content": "3", - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ], - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ], - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - }, - { - "content": "5%", - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ], - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - { - "content": "$30.00", - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ], - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - { - "content": "3/6/2021", - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ], - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - { - "content": "C789", - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ], - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - { - "content": "Printing Fee", - "polygon": [ - 2.345, - 6.2906, - 3.1351, - 6.2906, - 3.1351, - 6.4281, - 2.345, - 6.4281 - ], - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - { - "content": "10", - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ], - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - { - "content": "pages", - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ], - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - { - "content": "$1.00", - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ], - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - }, - { - "content": "20%", - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ], - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ], - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - }, - { - "content": "SUBTOTAL", - "polygon": [ - 6.0282, - 6.9118, - 6.7309, - 6.9118, - 6.7309, - 7.0199, - 6.0282, - 7.0199 - ], - "spans": [ - { - "offset": 759, - "length": 8 - } - ] - }, - { - "content": "$100.00", - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ], - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - { - "content": "SALES TAX", - "polygon": [ - 6.0382, - 7.2089, - 6.728, - 7.2089, - 6.728, - 7.317, - 6.0382, - 7.317 - ], - "spans": [ - { - "offset": 776, - "length": 9 - } - ] - }, - { - "content": "$10.00", - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ], - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - { - "content": "TOTAL", - "polygon": [ - 6.2969, - 7.5089, - 6.7309, - 7.5089, - 6.7309, - 7.617, - 6.2969, - 7.617 - ], - "spans": [ - { - "offset": 793, - "length": 5 - } - ] - }, - { - "content": "$110.00", - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ], - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - { - "content": "PREVIOUS UNPAID BALANCE", - "polygon": [ - 4.8126, - 7.8055, - 6.7249, - 7.8055, - 6.7249, - 7.9137, - 4.8126, - 7.9137 - ], - "spans": [ - { - "offset": 807, - "length": 23 - } - ] - }, - { - "content": "$500.00", - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ], - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - { - "content": "AMOUNT DUE", - "polygon": [ - 5.7652, - 8.1022, - 6.725, - 8.1022, - 6.725, - 8.2104, - 5.7652, - 8.2104 - ], - "spans": [ - { - "offset": 839, - "length": 10 - } - ] - }, - { - "content": "$610.00", - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ], - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - }, - { - "content": "THANK YOU FOR YOUR BUSINESS!", - "polygon": [ - 3.129, - 8.539, - 5.356, - 8.539, - 5.356, - 8.6442, - 3.129, - 8.6442 - ], - "spans": [ - { - "offset": 858, - "length": 28 - } - ] - }, - { - "content": "REMIT TO:", - "polygon": [ - 0.5909, - 9.1607, - 1.2603, - 9.1607, - 1.2603, - 9.2608, - 0.5909, - 9.2608 - ], - "spans": [ - { - "offset": 887, - "length": 9 - } - ] - }, - { - "content": "Contoso Billing", - "polygon": [ - 0.5882, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 0.5882, - 9.5059 - ], - "spans": [ - { - "offset": 897, - "length": 15 - } - ] - }, - { - "content": "123 Remit St", - "polygon": [ - 0.5945, - 9.5717, - 1.4337, - 9.5717, - 1.4337, - 9.681, - 0.5945, - 9.681 - ], - "spans": [ - { - "offset": 913, - "length": 12 - } - ] - }, - { - "content": "New York, NY, 10001", - "polygon": [ - 0.5943, - 9.773, - 1.9882, - 9.773, - 1.9882, - 9.9098, - 0.5943, - 9.9098 - ], - "spans": [ - { - "offset": 926, - "length": 19 - } - ] - } - ], - "spans": [ - { - "offset": 0, - "length": 958 - } - ] - } - ], - "tables": [ - { - "rowCount": 4, - "columnCount": 8, - "cells": [ - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "DATE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4932, - 5.329, - 1.3011, - 5.3213, - 1.3011, - 5.6056, - 0.5009, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 549, - "length": 4 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "ITEM CODE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.3213, - 2.2476, - 5.3213, - 2.2399, - 5.6056, - 1.3011, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 554, - "length": 9 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "DESCRIPTION", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2476, - 5.3213, - 4.3174, - 5.329, - 4.3097, - 5.6056, - 2.2399, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 564, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "QTY", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3174, - 5.329, - 4.7483, - 5.329, - 4.7483, - 5.6056, - 4.3097, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 576, - "length": 3 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "UM", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.329, - 5.5639, - 5.329, - 5.5639, - 5.6056, - 4.7483, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 580, - "length": 2 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "PRICE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.329, - 6.495, - 5.329, - 6.495, - 5.6056, - 5.5639, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 583, - "length": 5 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "TAX", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.329, - 7.1875, - 5.329, - 7.1952, - 5.6056, - 6.495, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 589, - "length": 3 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "AMOUNT", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1875, - 5.329, - 7.9954, - 5.329, - 7.9954, - 5.598, - 7.1952, - 5.6056 - ] - } - ], - "spans": [ - { - "offset": 593, - "length": 6 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/4/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5009, - 5.6056, - 1.3011, - 5.6056, - 1.3011, - 5.8976, - 0.5009, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "A123", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.6056, - 2.2399, - 5.6056, - 2.2322, - 5.8976, - 1.3011, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Consulting Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2399, - 5.6056, - 4.3097, - 5.6056, - 4.3097, - 5.8976, - 2.2322, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "2 :unselected:", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 5.6056, - 4.7483, - 5.6056, - 4.7483, - 5.8976, - 4.3097, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 634, - "length": 1 - }, - { - "offset": 946, - "length": 12 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "hours", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.6056, - 5.5639, - 5.6056, - 5.5639, - 5.8976, - 4.7483, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.6056, - 6.495, - 5.6056, - 6.495, - 5.8976, - 5.5639, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "10%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.6056, - 7.1952, - 5.6056, - 7.1952, - 5.8976, - 6.495, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 5.6056, - 7.9954, - 5.598, - 7.9954, - 5.9053, - 7.1952, - 5.8976 - ] - } - ], - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/5/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5009, - 5.8976, - 1.3011, - 5.8976, - 1.3011, - 6.1973, - 0.5086, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "B456", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 5.8976, - 2.2322, - 5.8976, - 2.2245, - 6.1973, - 1.3011, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Document Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2322, - 5.8976, - 4.3097, - 5.8976, - 4.3097, - 6.1973, - 2.2245, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "3", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 5.8976, - 4.7483, - 5.8976, - 4.7483, - 6.1973, - 4.3097, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 5.8976, - 5.5639, - 5.8976, - 5.5639, - 6.1973, - 4.7483, - 6.1973 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 2, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 5.8976, - 6.495, - 5.8976, - 6.495, - 6.1973, - 5.5639, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "5%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 5.8976, - 7.1952, - 5.8976, - 7.1952, - 6.1973, - 6.495, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 5.8976, - 7.9954, - 5.9053, - 7.9954, - 6.1896, - 7.1952, - 6.1973 - ] - } - ], - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "3/6/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5086, - 6.1973, - 1.3011, - 6.1973, - 1.3011, - 6.4969, - 0.5086, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "C789", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.3011, - 6.1973, - 2.2245, - 6.1973, - 2.2245, - 6.4969, - 1.3011, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "Printing Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.2245, - 6.1973, - 4.3097, - 6.1973, - 4.3097, - 6.4969, - 2.2245, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "10", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.3097, - 6.1973, - 4.7483, - 6.1973, - 4.7483, - 6.4969, - 4.3097, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "pages", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7483, - 6.1973, - 5.5639, - 6.1973, - 5.5639, - 6.4969, - 4.7483, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "$1.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.5639, - 6.1973, - 6.495, - 6.1973, - 6.495, - 6.4969, - 5.5639, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 6, - "rowSpan": 1, - "columnSpan": 1, - "content": "20%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.495, - 6.1973, - 7.1952, - 6.1973, - 7.1952, - 6.4969, - 6.495, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 7, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.1952, - 6.1973, - 7.9954, - 6.1896, - 7.9954, - 6.5046, - 7.1952, - 6.4969 - ] - } - ], - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4901, - 5.3293, - 7.9946, - 5.3289, - 7.9954, - 6.5019, - 0.4906, - 6.502 - ] - } - ], - "spans": [ - { - "offset": 549, - "length": 209 - }, - { - "offset": 946, - "length": 12 - } - ] - }, - { - "rowCount": 2, - "columnCount": 6, - "cells": [ - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SALESPERSON", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4977, - 4.565, - 1.8042, - 4.565, - 1.8119, - 4.8388, - 0.5054, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 472, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "P.O. NUMBER", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.8042, - 4.565, - 3.3105, - 4.565, - 3.3105, - 4.8388, - 1.8119, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 484, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "REQUISITIONER", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3105, - 4.565, - 4.6939, - 4.565, - 4.6862, - 4.8388, - 3.3105, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 496, - "length": 13 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "SHIPPED VIA", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.6939, - 4.565, - 5.7468, - 4.565, - 5.7468, - 4.8388, - 4.6862, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 510, - "length": 11 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "F.O.B. POINT", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.7468, - 4.565, - 6.815, - 4.565, - 6.815, - 4.8388, - 5.7468, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 522, - "length": 12 - } - ] - }, - { - "kind": "columnHeader", - "rowIndex": 0, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "TERMS", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.815, - 4.565, - 7.9985, - 4.565, - 7.9985, - 4.8388, - 6.815, - 4.8388 - ] - } - ], - "spans": [ - { - "offset": 535, - "length": 5 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5054, - 4.8388, - 1.8119, - 4.8388, - 1.8119, - 5.1058, - 0.5131, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "PO-3333", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.8119, - 4.8388, - 3.3105, - 4.8388, - 3.3105, - 5.1058, - 1.8119, - 5.1058 - ] - } - ], - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 2, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3105, - 4.8388, - 4.6862, - 4.8388, - 4.6862, - 5.1058, - 3.3105, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 3, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.6862, - 4.8388, - 5.7468, - 4.8388, - 5.7468, - 5.1058, - 4.6862, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 4, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.7468, - 4.8388, - 6.815, - 4.8388, - 6.815, - 5.1058, - 5.7468, - 5.1058 - ] - } - ], - "spans": [] - }, - { - "rowIndex": 1, - "columnIndex": 5, - "rowSpan": 1, - "columnSpan": 1, - "content": "", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.815, - 4.8388, - 7.9985, - 4.8388, - 7.9985, - 5.1125, - 6.815, - 5.1058 - ] - } - ], - "spans": [] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.4971, - 4.565, - 7.9889, - 4.5653, - 7.989, - 5.1146, - 0.4963, - 5.1141 - ] - } - ], - "spans": [ - { - "offset": 472, - "length": 76 - } - ] - }, - { - "rowCount": 5, - "columnCount": 2, - "cells": [ - { - "rowIndex": 0, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SUBTOTAL", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7474, - 6.7934, - 6.8058, - 6.7934, - 6.8105, - 7.0886, - 4.7474, - 7.0886 - ] - } - ], - "spans": [ - { - "offset": 759, - "length": 8 - } - ] - }, - { - "rowIndex": 0, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$100.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8058, - 6.7934, - 7.9981, - 6.7934, - 7.9981, - 7.0934, - 6.8105, - 7.0886 - ] - } - ], - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "SALES TAX", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7474, - 7.0886, - 6.8105, - 7.0886, - 6.8105, - 7.3743, - 4.7427, - 7.3743 - ] - } - ], - "spans": [ - { - "offset": 776, - "length": 9 - } - ] - }, - { - "rowIndex": 1, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.0886, - 7.9981, - 7.0934, - 7.9981, - 7.3934, - 6.8105, - 7.3743 - ] - } - ], - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "TOTAL", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.3743, - 6.8105, - 7.3743, - 6.8105, - 7.6839, - 4.7427, - 7.6839 - ] - } - ], - "spans": [ - { - "offset": 793, - "length": 5 - } - ] - }, - { - "rowIndex": 2, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$110.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.3743, - 7.9981, - 7.3934, - 7.9981, - 7.6886, - 6.8105, - 7.6839 - ] - } - ], - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "PREVIOUS UNPAID BALANCE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.6839, - 6.8105, - 7.6839, - 6.8105, - 7.9743, - 4.7427, - 7.9743 - ] - } - ], - "spans": [ - { - "offset": 807, - "length": 23 - } - ] - }, - { - "rowIndex": 3, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$500.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.6839, - 7.9981, - 7.6886, - 7.9981, - 7.9839, - 6.8105, - 7.9743 - ] - } - ], - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - { - "rowIndex": 4, - "columnIndex": 0, - "rowSpan": 1, - "columnSpan": 1, - "content": "AMOUNT DUE", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7427, - 7.9743, - 6.8105, - 7.9743, - 6.8105, - 8.2839, - 4.7381, - 8.2839 - ] - } - ], - "spans": [ - { - "offset": 839, - "length": 10 - } - ] - }, - { - "rowIndex": 4, - "columnIndex": 1, - "rowSpan": 1, - "columnSpan": 1, - "content": "$610.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.8105, - 7.9743, - 7.9981, - 7.9839, - 7.9981, - 8.2839, - 6.8105, - 8.2839 - ] - } - ], - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - } - ], - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.7456, - 6.7793, - 8.0143, - 6.7788, - 8.0137, - 8.2981, - 4.7446, - 8.2981 - ] - } - ], - "spans": [ - { - "offset": 759, - "length": 98 - } - ] - } - ], - "documents": [ - { - "docType": "prebuilt:invoice", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "fields": { - "AmountDue": { - "type": "number", - "valueNumber": 610, - "content": "$610.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 8.0584, - 7.9181, - 8.0584, - 7.9181, - 8.2022, - 7.3842, - 8.2022 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 850, - "length": 7 - } - ] - }, - "BillingAddress": { - "type": "string", - "valueString": "123 Bill St, Redmond WA, 98052", - "content": "123 Bill St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 3.9681, - 2.0083, - 3.9681, - 2.0083, - 4.3082, - 0.5943, - 4.3082 - ] - } - ], - "confidence": 0.947, - "spans": [ - { - "offset": 376, - "length": 12 - }, - { - "offset": 418, - "length": 17 - } - ] - }, - "BillingAddressRecipient": { - "type": "string", - "valueString": "Microsoft Finance", - "content": "Microsoft Finance", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 3.7641, - 1.7878, - 3.7641, - 1.7878, - 3.8794, - 0.5943, - 3.8794 - ] - } - ], - "confidence": 0.957, - "spans": [ - { - "offset": 320, - "length": 17 - } - ] - }, - "CustomerAddress": { - "type": "string", - "valueString": "123 Other St, Redmond WA, 98052", - "content": "123 Other St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 2.8476, - 2.0083, - 2.8476, - 2.0083, - 3.1878, - 0.5943, - 3.1878 - ] - } - ], - "confidence": 0.947, - "spans": [ - { - "offset": 253, - "length": 31 - } - ] - }, - "CustomerAddressRecipient": { - "type": "string", - "valueString": "Microsoft Corp", - "content": "Microsoft Corp", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 2.6436, - 1.586, - 2.6436, - 1.586, - 2.7871, - 0.5943, - 2.7871 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 238, - "length": 14 - } - ] - }, - "CustomerId": { - "type": "string", - "valueString": "CID-12345", - "content": "CID-12345", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3369, - 2.4491, - 7.9951, - 2.4491, - 7.9951, - 2.5486, - 7.3369, - 2.5486 - ] - } - ], - "confidence": 0.964, - "spans": [ - { - "offset": 228, - "length": 9 - } - ] - }, - "CustomerName": { - "type": "string", - "valueString": "MICROSOFT CORPORATION", - "content": "MICROSOFT CORPORATION", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2419, - 2.0391, - 7.9825, - 2.0391, - 7.9825, - 2.1386, - 6.2419, - 2.1386 - ] - } - ], - "confidence": 0.949, - "spans": [ - { - "offset": 153, - "length": 21 - } - ] - }, - "DueDate": { - "type": "date", - "valueDate": "2019-12-15", - "content": "12/15/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2494, - 1.8206, - 7.993, - 1.8206, - 7.993, - 1.9515, - 7.2494, - 1.9515 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 127, - "length": 10 - } - ] - }, - "InvoiceDate": { - "type": "date", - "valueDate": "2019-11-15", - "content": "11/15/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2528, - 1.6139, - 7.993, - 1.6139, - 7.993, - 1.7449, - 7.2528, - 1.7449 - ] - } - ], - "confidence": 0.972, - "spans": [ - { - "offset": 86, - "length": 10 - } - ] - }, - "InvoiceId": { - "type": "string", - "valueString": "INV-100", - "content": "INV-100", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4959, - 1.422, - 7.9988, - 1.422, - 7.9988, - 1.5215, - 7.4959, - 1.5215 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 51, - "length": 7 - } - ] - }, - "InvoiceTotal": { - "type": "number", - "valueNumber": 110, - "content": "$110.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 7.465, - 7.9181, - 7.465, - 7.9181, - 7.6089, - 7.3842, - 7.6089 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 799, - "length": 7 - } - ] - }, - "Items": { - "type": "array", - "valueArray": [ - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 60, - "content": "$60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8215, - 7.4642, - 5.8215 - ] - } - ], - "confidence": 0.902, - "spans": [ - { - "offset": 653, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-04", - "content": "3/4/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.682, - 1.2092, - 5.682, - 1.2092, - 5.8243, - 0.592, - 5.8243 - ] - } - ], - "confidence": 0.938, - "spans": [ - { - "offset": 600, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Consulting Services", - "content": "Consulting Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.3388, - 5.6883, - 3.6278, - 5.6883, - 3.6278, - 5.8312, - 2.3388, - 5.8312 - ] - } - ], - "confidence": 0.9, - "spans": [ - { - "offset": 614, - "length": 19 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "A123", - "content": "A123", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6069, - 5.6948, - 1.9417, - 5.6948, - 1.9417, - 5.803, - 1.6069, - 5.803 - ] - } - ], - "confidence": 0.877, - "spans": [ - { - "offset": 609, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 2, - "content": "2", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5977, - 5.6948, - 4.6635, - 5.6948, - 4.6635, - 5.8017, - 4.5977, - 5.8017 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 634, - "length": 1 - } - ] - }, - "Tax": { - "type": "number", - "content": "10%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.7168, - 5.6932, - 6.9826, - 5.6932, - 6.9826, - 5.8045, - 6.7168, - 5.8045 - ] - } - ], - "confidence": 0.78, - "spans": [ - { - "offset": 649, - "length": 3 - } - ] - }, - "Unit": { - "type": "string", - "valueString": "hours", - "content": "hours", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.8444, - 5.6883, - 5.2071, - 5.6883, - 5.2071, - 5.803, - 4.8444, - 5.803 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 636, - "length": 5 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 30, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.9669, - 5.6777, - 6.4142, - 5.6777, - 6.4142, - 5.8215, - 5.9669, - 5.8215 - ] - } - ], - "confidence": 0.828, - "spans": [ - { - "offset": 642, - "length": 6 - } - ] - } - }, - "content": "3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.6777, - 7.9116, - 5.6777, - 7.9116, - 5.8312, - 0.592, - 5.8312 - ] - } - ], - "confidence": 0.955, - "spans": [ - { - "offset": 600, - "length": 59 - } - ] - }, - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 30, - "content": "$30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.1182, - 7.4642, - 6.1182 - ] - } - ], - "confidence": 0.916, - "spans": [ - { - "offset": 699, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-05", - "content": "3/5/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.9787, - 1.2088, - 5.9787, - 1.2088, - 6.121, - 0.592, - 6.121 - ] - } - ], - "confidence": 0.902, - "spans": [ - { - "offset": 660, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Document Fee", - "content": "Document Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.345, - 5.993, - 3.3096, - 5.993, - 3.3096, - 6.0997, - 2.345, - 6.0997 - ] - } - ], - "confidence": 0.901, - "spans": [ - { - "offset": 674, - "length": 12 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "B456", - "content": "B456", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6214, - 5.9915, - 1.9419, - 5.9915, - 1.9419, - 6.0997, - 1.6214, - 6.0997 - ] - } - ], - "confidence": 0.886, - "spans": [ - { - "offset": 669, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 3, - "content": "3", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5967, - 5.9915, - 4.6627, - 5.9915, - 4.6627, - 6.0997, - 4.5967, - 6.0997 - ] - } - ], - "confidence": 0.898, - "spans": [ - { - "offset": 687, - "length": 1 - } - ] - }, - "Tax": { - "type": "number", - "content": "5%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.7508, - 5.9898, - 6.9393, - 5.9898, - 6.9393, - 6.1012, - 6.7508, - 6.1012 - ] - } - ], - "confidence": 0.772, - "spans": [ - { - "offset": 696, - "length": 2 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 5.9669, - 5.9743, - 6.4142, - 5.9743, - 6.4142, - 6.1182, - 5.9669, - 6.1182 - ] - } - ], - "confidence": 0.831, - "spans": [ - { - "offset": 689, - "length": 6 - } - ] - } - }, - "content": "3/5/2021 B456 Document Fee 3 $10.00 5% $30.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 5.9743, - 7.9116, - 5.9743, - 7.9116, - 6.121, - 0.592, - 6.121 - ] - } - ], - "confidence": 0.941, - "spans": [ - { - "offset": 660, - "length": 45 - } - ] - }, - { - "type": "object", - "valueObject": { - "Amount": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4642, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4184, - 7.4642, - 6.4184 - ] - } - ], - "confidence": 0.959, - "spans": [ - { - "offset": 752, - "length": 6 - } - ] - }, - "Date": { - "type": "date", - "valueDate": "2021-03-06", - "content": "3/6/2021", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 6.2789, - 1.2088, - 6.2789, - 1.2088, - 6.4213, - 0.592, - 6.4213 - ] - } - ], - "confidence": 0.903, - "spans": [ - { - "offset": 706, - "length": 8 - } - ] - }, - "Description": { - "type": "string", - "valueString": "Printing Fee", - "content": "Printing Fee", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 2.345, - 6.2906, - 3.1351, - 6.2906, - 3.1351, - 6.4281, - 2.345, - 6.4281 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 720, - "length": 12 - } - ] - }, - "ProductCode": { - "type": "string", - "valueString": "C789", - "content": "C789", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.6152, - 6.2918, - 1.94, - 6.2918, - 1.94, - 6.3999, - 1.6152, - 6.3999 - ] - } - ], - "confidence": 0.898, - "spans": [ - { - "offset": 715, - "length": 4 - } - ] - }, - "Quantity": { - "type": "number", - "valueNumber": 10, - "content": "10", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.5158, - 6.2918, - 4.6637, - 6.2918, - 4.6637, - 6.3999, - 4.5158, - 6.3999 - ] - } - ], - "confidence": 0.903, - "spans": [ - { - "offset": 733, - "length": 2 - } - ] - }, - "Tax": { - "type": "number", - "content": "20%", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.712, - 6.2901, - 6.9826, - 6.2901, - 6.9826, - 6.4014, - 6.712, - 6.4014 - ] - } - ], - "confidence": 0.791, - "spans": [ - { - "offset": 748, - "length": 3 - } - ] - }, - "Unit": { - "type": "string", - "valueString": "pages", - "content": "pages", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 4.8444, - 6.3196, - 5.2199, - 6.3196, - 5.2199, - 6.4281, - 4.8444, - 6.4281 - ] - } - ], - "confidence": 0.899, - "spans": [ - { - "offset": 736, - "length": 5 - } - ] - }, - "UnitPrice": { - "type": "number", - "valueNumber": 1, - "content": "$1.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.0502, - 6.2746, - 6.4142, - 6.2746, - 6.4142, - 6.4184, - 6.0502, - 6.4184 - ] - } - ], - "confidence": 0.829, - "spans": [ - { - "offset": 742, - "length": 5 - } - ] - } - }, - "content": "3/6/2021 C789 Printing Fee 10 pages $1.00 20% $10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.592, - 6.2746, - 7.9116, - 6.2746, - 7.9116, - 6.4281, - 0.592, - 6.4281 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 706, - "length": 52 - } - ] - } - ] - }, - "Locale": { - "type": "string", - "valueString": "en-US", - "confidence": 1 - }, - "PreviousUnpaidBalance": { - "type": "number", - "valueNumber": 500, - "content": "$500.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 7.7617, - 7.9181, - 7.7617, - 7.9181, - 7.9055, - 7.3842, - 7.9055 - ] - } - ], - "confidence": 0.962, - "spans": [ - { - "offset": 831, - "length": 7 - } - ] - }, - "PurchaseOrder": { - "type": "string", - "valueString": "PO-3333", - "content": "PO-3333", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 1.9114, - 4.9282, - 2.4718, - 4.9282, - 2.4718, - 5.0363, - 1.9114, - 5.0363 - ] - } - ], - "confidence": 0.967, - "spans": [ - { - "offset": 541, - "length": 7 - } - ] - }, - "RemittanceAddress": { - "type": "string", - "valueString": "123 Remit St New York, NY, 10001", - "content": "123 Remit St New York, NY, 10001", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 9.5717, - 1.9882, - 9.5717, - 1.9882, - 9.9098, - 0.5943, - 9.9098 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 913, - "length": 32 - } - ] - }, - "RemittanceAddressRecipient": { - "type": "string", - "valueString": "Contoso Billing", - "content": "Contoso Billing", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5882, - 9.3631, - 1.5828, - 9.3631, - 1.5828, - 9.5059, - 0.5882, - 9.5059 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 897, - "length": 15 - } - ] - }, - "ServiceAddress": { - "type": "string", - "valueString": "123 Service St, Redmond WA, 98052", - "content": "123 Service St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2197, - 3.9734, - 7.6337, - 3.9734, - 7.6337, - 4.3082, - 6.2197, - 4.3082 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 402, - "length": 15 - }, - { - "offset": 454, - "length": 17 - } - ] - }, - "ServiceAddressRecipient": { - "type": "string", - "valueString": "Microsoft Services", - "content": "Microsoft Services", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.2197, - 3.7641, - 7.4427, - 3.7641, - 7.4427, - 3.8794, - 6.2197, - 3.8794 - ] - } - ], - "confidence": 0.951, - "spans": [ - { - "offset": 357, - "length": 18 - } - ] - }, - "ServiceEndDate": { - "type": "date", - "valueDate": "2019-11-14", - "content": "11/14/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.2528, - 2.2306, - 7.9952, - 2.2306, - 7.9952, - 2.3615, - 7.2528, - 2.3615 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 204, - "length": 10 - } - ] - }, - "ServiceStartDate": { - "type": "date", - "valueDate": "2019-10-14", - "content": "10/14/2019", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 6.3357, - 2.2306, - 7.0749, - 2.2306, - 7.0749, - 2.3615, - 6.3357, - 2.3615 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 191, - "length": 10 - } - ] - }, - "ShippingAddress": { - "type": "string", - "valueString": "123 Ship St, Redmond WA, 98052", - "content": "123 Ship St, Redmond WA, 98052", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3454, - 3.9681, - 4.7594, - 3.9681, - 4.7594, - 4.3082, - 3.3454, - 4.3082 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 389, - "length": 12 - }, - { - "offset": 436, - "length": 17 - } - ] - }, - "ShippingAddressRecipient": { - "type": "string", - "valueString": "Microsoft Delivery", - "content": "Microsoft Delivery", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 3.3454, - 3.7641, - 4.5762, - 3.7641, - 4.5762, - 3.9076, - 3.3454, - 3.9076 - ] - } - ], - "confidence": 0.955, - "spans": [ - { - "offset": 338, - "length": 18 - } - ] - }, - "SubTotal": { - "type": "number", - "valueNumber": 100, - "content": "$100.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.3842, - 6.8679, - 7.9181, - 6.8679, - 7.9181, - 7.0118, - 7.3842, - 7.0118 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 768, - "length": 7 - } - ] - }, - "TotalTax": { - "type": "number", - "valueNumber": 10, - "content": "$10.00", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 7.4709, - 7.165, - 7.9182, - 7.165, - 7.9182, - 7.3089, - 7.4709, - 7.3089 - ] - } - ], - "confidence": 0.973, - "spans": [ - { - "offset": 786, - "length": 6 - } - ] - }, - "VendorAddress": { - "type": "string", - "valueString": "123 456th St New York, NY, 10001", - "content": "123 456th St New York, NY, 10001", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5943, - 1.6092, - 1.9894, - 1.6092, - 1.9894, - 1.9675, - 0.5943, - 1.9675 - ] - } - ], - "confidence": 0.946, - "spans": [ - { - "offset": 59, - "length": 12 - }, - { - "offset": 97, - "length": 19 - } - ] - }, - "VendorAddressRecipient": { - "type": "string", - "valueString": "Contoso Headquarters", - "content": "Contoso Headquarters", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5882, - 1.4239, - 2.0978, - 1.4239, - 2.0978, - 1.5664, - 0.5882, - 1.5664 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 21, - "length": 20 - } - ] - }, - "VendorName": { - "type": "string", - "valueString": "CONTOSO LTD.", - "content": "CONTOSO LTD.", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0.5911, - 0.6857, - 2.3181, - 0.6857, - 2.3181, - 0.8664, - 0.5911, - 0.8664 - ] - } - ], - "confidence": 0.956, - "spans": [ - { - "offset": 0, - "length": 12 - } - ] - } - }, - "confidence": 1, - "spans": [ - { - "offset": 0, - "length": 958 - } - ] - } - ] - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "prebuilt-invoice", + "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2021-09-24T13:00:46Z", + "lastUpdatedDateTime": "2021-09-24T13:00:49Z", + "analyzeResult": { + "apiVersion": "2023-07-31", + "modelId": "prebuilt-invoice", + "stringIndexType": "textElements", + "content": "CONTOSO LTD.\nINVOICE\nContoso Headquarters\nINVOICE: INV-100\n123 456th St\nINVOICE DATE: 11/15/2019\nNew York, NY, 10001\nDUE DATE: 12/15/2019\nCUSTOMER NAME: MICROSOFT CORPORATION\nSERVICE PERIOD: 10/14/2019 – 11/14/2019\nCUSTOMER ID: CID-12345\nMicrosoft Corp\n123 Other St,\nRedmond WA, 98052\nBILL TO:\nSHIP TO:\nSERVICE ADDRESS:\nMicrosoft Finance\nMicrosoft Delivery\nMicrosoft Services\n123 Bill St,\n123 Ship St,\n123 Service St,\nRedmond WA, 98052\nRedmond WA, 98052\nRedmond WA, 98052\nSALESPERSON\nP.O. NUMBER\nREQUISITIONER\nSHIPPED VIA\nF.O.B. POINT\nTERMS\nPO-3333\nDATE\nITEM CODE\nDESCRIPTION\nQTY\nUM\nPRICE\nTAX\nAMOUNT\n3/4/2021\nA123\nConsulting Services\n2\nhours\n$30.00\n10%\n$60.00\n3/5/2021\nB456\nDocument Fee\n3\n$10.00\n5%\n$30.00\n3/6/2021\nC789\nPrinting Fee\n10\npages\n$1.00\n20%\n$10.00\nSUBTOTAL\n$100.00\nSALES TAX\n$10.00\nTOTAL\n$110.00\nPREVIOUS UNPAID BALANCE\n$500.00\nAMOUNT DUE\n$610.00\nTHANK YOU FOR YOUR BUSINESS!\nREMIT TO:\nContoso Billing\n123 Remit St\nNew York, NY, 10001\n:unselected:", + "pages": [ + { + "pageNumber": 1, + "angle": 0, + "width": 8.5, + "height": 11, + "unit": "inch", + "words": [ + { + "content": "CONTOSO", + "polygon": [ + 0.5911, + 0.6857, + 1.7451, + 0.6857, + 1.7451, + 0.8664, + 0.5911, + 0.8664 + ], + "confidence": 1, + "span": { + "offset": 0, + "length": 7 + } + }, + { + "content": "LTD.", + "polygon": [ + 1.8441, + 0.6879, + 2.3181, + 0.6879, + 2.3181, + 0.865, + 1.8441, + 0.865 + ], + "confidence": 1, + "span": { + "offset": 8, + "length": 4 + } + }, + { + "content": "INVOICE", + "polygon": [ + 7.0751, + 0.589, + 7.9886, + 0.589, + 7.9886, + 0.7697, + 7.0751, + 0.7697 + ], + "confidence": 1, + "span": { + "offset": 13, + "length": 7 + } + }, + { + "content": "Contoso", + "polygon": [ + 0.5882, + 1.4303, + 1.1337, + 1.4303, + 1.1337, + 1.5383, + 0.5882, + 1.5383 + ], + "confidence": 1, + "span": { + "offset": 21, + "length": 7 + } + }, + { + "content": "Headquarters", + "polygon": [ + 1.1905, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 1.1905, + 1.5664 + ], + "confidence": 1, + "span": { + "offset": 29, + "length": 12 + } + }, + { + "content": "INVOICE:", + "polygon": [ + 6.8599, + 1.4217, + 7.4328, + 1.4217, + 7.4328, + 1.5218, + 6.8599, + 1.5218 + ], + "confidence": 1, + "span": { + "offset": 42, + "length": 8 + } + }, + { + "content": "INV-100", + "polygon": [ + 7.4959, + 1.422, + 7.9988, + 1.422, + 7.9988, + 1.5215, + 7.4959, + 1.5215 + ], + "confidence": 1, + "span": { + "offset": 51, + "length": 7 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 1.6339, + 0.8213, + 1.6339, + 0.8213, + 1.742, + 0.5945, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 59, + "length": 3 + } + }, + { + "content": "456th", + "polygon": [ + 0.874, + 1.6092, + 1.2102, + 1.6092, + 1.2102, + 1.742, + 0.874, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 63, + "length": 5 + } + }, + { + "content": "St", + "polygon": [ + 1.2598, + 1.6339, + 1.3812, + 1.6339, + 1.3812, + 1.742, + 1.2598, + 1.742 + ], + "confidence": 1, + "span": { + "offset": 69, + "length": 2 + } + }, + { + "content": "INVOICE", + "polygon": [ + 6.2263, + 1.6254, + 6.7562, + 1.6254, + 6.7562, + 1.7256, + 6.2263, + 1.7256 + ], + "confidence": 1, + "span": { + "offset": 72, + "length": 7 + } + }, + { + "content": "DATE:", + "polygon": [ + 6.8132, + 1.6267, + 7.1891, + 1.6267, + 7.1891, + 1.7248, + 6.8132, + 1.7248 + ], + "confidence": 1, + "span": { + "offset": 80, + "length": 5 + } + }, + { + "content": "11/15/2019", + "polygon": [ + 7.2528, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 7.2528, + 1.7449 + ], + "confidence": 1, + "span": { + "offset": 86, + "length": 10 + } + }, + { + "content": "New", + "polygon": [ + 0.5943, + 1.8385, + 0.8848, + 1.8385, + 0.8848, + 1.9454, + 0.5943, + 1.9454 + ], + "confidence": 1, + "span": { + "offset": 97, + "length": 3 + } + }, + { + "content": "York,", + "polygon": [ + 0.9293, + 1.8307, + 1.2568, + 1.8307, + 1.2568, + 1.9675, + 0.9293, + 1.9675 + ], + "confidence": 1, + "span": { + "offset": 101, + "length": 5 + } + }, + { + "content": "NY,", + "polygon": [ + 1.3205, + 1.8382, + 1.5242, + 1.8382, + 1.5242, + 1.9675, + 1.3205, + 1.9675 + ], + "confidence": 1, + "span": { + "offset": 107, + "length": 3 + } + }, + { + "content": "10001", + "polygon": [ + 1.5915, + 1.8372, + 1.9894, + 1.8372, + 1.9894, + 1.9454, + 1.5915, + 1.9454 + ], + "confidence": 1, + "span": { + "offset": 111, + "length": 5 + } + }, + { + "content": "DUE", + "polygon": [ + 6.4966, + 1.8333, + 6.7569, + 1.8333, + 6.7569, + 1.9322, + 6.4966, + 1.9322 + ], + "confidence": 1, + "span": { + "offset": 117, + "length": 3 + } + }, + { + "content": "DATE:", + "polygon": [ + 6.8126, + 1.8333, + 7.1846, + 1.8333, + 7.1846, + 1.9315, + 6.8126, + 1.9315 + ], + "confidence": 1, + "span": { + "offset": 121, + "length": 5 + } + }, + { + "content": "12/15/2019", + "polygon": [ + 7.2494, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 7.2494, + 1.9515 + ], + "confidence": 1, + "span": { + "offset": 127, + "length": 10 + } + }, + { + "content": "CUSTOMER", + "polygon": [ + 4.9513, + 2.0388, + 5.6868, + 2.0388, + 5.6868, + 2.1389, + 4.9513, + 2.1389 + ], + "confidence": 1, + "span": { + "offset": 138, + "length": 8 + } + }, + { + "content": "NAME:", + "polygon": [ + 5.7412, + 2.04, + 6.1764, + 2.04, + 6.1764, + 2.1381, + 5.7412, + 2.1381 + ], + "confidence": 1, + "span": { + "offset": 147, + "length": 5 + } + }, + { + "content": "MICROSOFT", + "polygon": [ + 6.2419, + 2.0391, + 6.9981, + 2.0391, + 6.9981, + 2.1386, + 6.2419, + 2.1386 + ], + "confidence": 1, + "span": { + "offset": 153, + "length": 9 + } + }, + { + "content": "CORPORATION", + "polygon": [ + 7.0448, + 2.0391, + 7.9825, + 2.0391, + 7.9825, + 2.1386, + 7.0448, + 2.1386 + ], + "confidence": 1, + "span": { + "offset": 163, + "length": 11 + } + }, + { + "content": "SERVICE", + "polygon": [ + 5.1667, + 2.2421, + 5.6923, + 2.2421, + 5.6923, + 2.3422, + 5.1667, + 2.3422 + ], + "confidence": 1, + "span": { + "offset": 175, + "length": 7 + } + }, + { + "content": "PERIOD:", + "polygon": [ + 5.748, + 2.2421, + 6.2721, + 2.2421, + 6.2721, + 2.3422, + 5.748, + 2.3422 + ], + "confidence": 1, + "span": { + "offset": 183, + "length": 7 + } + }, + { + "content": "10/14/2019", + "polygon": [ + 6.3357, + 2.2306, + 7.0749, + 2.2306, + 7.0749, + 2.3615, + 6.3357, + 2.3615 + ], + "confidence": 1, + "span": { + "offset": 191, + "length": 10 + } + }, + { + "content": "–", + "polygon": [ + 7.122, + 2.2922, + 7.1995, + 2.2922, + 7.1995, + 2.3037, + 7.122, + 2.3037 + ], + "confidence": 1, + "span": { + "offset": 202, + "length": 1 + } + }, + { + "content": "11/14/2019", + "polygon": [ + 7.2528, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 7.2528, + 2.3615 + ], + "confidence": 1, + "span": { + "offset": 204, + "length": 10 + } + }, + { + "content": "CUSTOMER", + "polygon": [ + 6.3253, + 2.4488, + 7.0608, + 2.4488, + 7.0608, + 2.5489, + 6.3253, + 2.5489 + ], + "confidence": 1, + "span": { + "offset": 215, + "length": 8 + } + }, + { + "content": "ID:", + "polygon": [ + 7.1153, + 2.45, + 7.2809, + 2.45, + 7.2809, + 2.5481, + 7.1153, + 2.5481 + ], + "confidence": 1, + "span": { + "offset": 224, + "length": 3 + } + }, + { + "content": "CID-12345", + "polygon": [ + 7.3369, + 2.4491, + 7.9951, + 2.4491, + 7.9951, + 2.5486, + 7.3369, + 2.5486 + ], + "confidence": 1, + "span": { + "offset": 228, + "length": 9 + } + }, + { + "content": "Microsoft", + "polygon": [ + 0.5943, + 2.6436, + 1.2303, + 2.6436, + 1.2303, + 2.759, + 0.5943, + 2.759 + ], + "confidence": 1, + "span": { + "offset": 238, + "length": 9 + } + }, + { + "content": "Corp", + "polygon": [ + 1.2808, + 2.651, + 1.586, + 2.651, + 1.586, + 2.7871, + 1.2808, + 2.7871 + ], + "confidence": 1, + "span": { + "offset": 248, + "length": 4 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 2.8541, + 0.8213, + 2.8541, + 0.8213, + 2.9623, + 0.5945, + 2.9623 + ], + "confidence": 1, + "span": { + "offset": 253, + "length": 3 + } + }, + { + "content": "Other", + "polygon": [ + 0.875, + 2.8476, + 1.262, + 2.8476, + 1.262, + 2.9623, + 0.875, + 2.9623 + ], + "confidence": 1, + "span": { + "offset": 257, + "length": 5 + } + }, + { + "content": "St,", + "polygon": [ + 1.3058, + 2.8541, + 1.4633, + 2.8541, + 1.4633, + 2.9845, + 1.3058, + 2.9845 + ], + "confidence": 1, + "span": { + "offset": 263, + "length": 3 + } + }, + { + "content": "Redmond", + "polygon": [ + 0.5943, + 3.0513, + 1.2222, + 3.0513, + 1.2222, + 3.1656, + 0.5943, + 3.1656 + ], + "confidence": 1, + "span": { + "offset": 267, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 1.2753, + 3.0585, + 1.5468, + 3.0585, + 1.5468, + 3.1878, + 1.2753, + 3.1878 + ], + "confidence": 1, + "span": { + "offset": 275, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 1.6033, + 3.0575, + 2.0083, + 3.0575, + 2.0083, + 3.1656, + 1.6033, + 3.1656 + ], + "confidence": 1, + "span": { + "offset": 279, + "length": 5 + } + }, + { + "content": "BILL", + "polygon": [ + 0.5909, + 3.5603, + 0.8438, + 3.5603, + 0.8438, + 3.6579, + 0.5909, + 3.6579 + ], + "confidence": 1, + "span": { + "offset": 285, + "length": 4 + } + }, + { + "content": "TO:", + "polygon": [ + 0.8846, + 3.559, + 1.1032, + 3.559, + 1.1032, + 3.6592, + 0.8846, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 290, + "length": 3 + } + }, + { + "content": "SHIP", + "polygon": [ + 3.3361, + 3.559, + 3.6278, + 3.559, + 3.6278, + 3.6592, + 3.3361, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 294, + "length": 4 + } + }, + { + "content": "TO:", + "polygon": [ + 3.6716, + 3.559, + 3.8903, + 3.559, + 3.8903, + 3.6592, + 3.6716, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 299, + "length": 3 + } + }, + { + "content": "SERVICE", + "polygon": [ + 6.2104, + 3.559, + 6.7361, + 3.559, + 6.7361, + 3.6592, + 6.2104, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 303, + "length": 7 + } + }, + { + "content": "ADDRESS:", + "polygon": [ + 6.7828, + 3.559, + 7.4232, + 3.559, + 7.4232, + 3.6592, + 6.7828, + 3.6592 + ], + "confidence": 1, + "span": { + "offset": 311, + "length": 8 + } + }, + { + "content": "Microsoft", + "polygon": [ + 0.5943, + 3.7641, + 1.2303, + 3.7641, + 1.2303, + 3.8794, + 0.5943, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 320, + "length": 9 + } + }, + { + "content": "Finance", + "polygon": [ + 1.287, + 3.7701, + 1.7878, + 3.7701, + 1.7878, + 3.8794, + 1.287, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 330, + "length": 7 + } + }, + { + "content": "Microsoft", + "polygon": [ + 3.3454, + 3.7641, + 3.9814, + 3.7641, + 3.9814, + 3.8794, + 3.3454, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 338, + "length": 9 + } + }, + { + "content": "Delivery", + "polygon": [ + 4.0381, + 3.7647, + 4.5762, + 3.7647, + 4.5762, + 3.9076, + 4.0381, + 3.9076 + ], + "confidence": 1, + "span": { + "offset": 348, + "length": 8 + } + }, + { + "content": "Microsoft", + "polygon": [ + 6.2197, + 3.7641, + 6.8557, + 3.7641, + 6.8557, + 3.8794, + 6.2197, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 357, + "length": 9 + } + }, + { + "content": "Services", + "polygon": [ + 6.9042, + 3.7701, + 7.4427, + 3.7701, + 7.4427, + 3.8794, + 6.9042, + 3.8794 + ], + "confidence": 1, + "span": { + "offset": 367, + "length": 8 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 3.9746, + 0.8213, + 3.9746, + 0.8213, + 4.0827, + 0.5945, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 376, + "length": 3 + } + }, + { + "content": "Bill", + "polygon": [ + 0.8842, + 3.9681, + 1.0657, + 3.9681, + 1.0657, + 4.0817, + 0.8842, + 4.0817 + ], + "confidence": 1, + "span": { + "offset": 380, + "length": 4 + } + }, + { + "content": "St,", + "polygon": [ + 1.1222, + 3.9746, + 1.2765, + 3.9746, + 1.2765, + 4.1049, + 1.1222, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 385, + "length": 3 + } + }, + { + "content": "123", + "polygon": [ + 3.3456, + 3.9746, + 3.5724, + 3.9746, + 3.5724, + 4.0827, + 3.3456, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 389, + "length": 3 + } + }, + { + "content": "Ship", + "polygon": [ + 3.6239, + 3.9681, + 3.9042, + 3.9681, + 3.9042, + 4.1109, + 3.6239, + 4.1109 + ], + "confidence": 1, + "span": { + "offset": 393, + "length": 4 + } + }, + { + "content": "St,", + "polygon": [ + 3.9536, + 3.9746, + 4.1111, + 3.9746, + 4.1111, + 4.1049, + 3.9536, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 398, + "length": 3 + } + }, + { + "content": "123", + "polygon": [ + 6.2199, + 3.9746, + 6.4467, + 3.9746, + 6.4467, + 4.0827, + 6.2199, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 402, + "length": 3 + } + }, + { + "content": "Service", + "polygon": [ + 6.4985, + 3.9734, + 6.9738, + 3.9734, + 6.9738, + 4.0827, + 6.4985, + 4.0827 + ], + "confidence": 1, + "span": { + "offset": 406, + "length": 7 + } + }, + { + "content": "St,", + "polygon": [ + 7.0246, + 3.9746, + 7.1821, + 3.9746, + 7.1821, + 4.1049, + 7.0246, + 4.1049 + ], + "confidence": 1, + "span": { + "offset": 414, + "length": 3 + } + }, + { + "content": "Redmond", + "polygon": [ + 0.5943, + 4.1717, + 1.2222, + 4.1717, + 1.2222, + 4.2861, + 0.5943, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 418, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 1.2753, + 4.1789, + 1.5468, + 4.1789, + 1.5468, + 4.3082, + 1.2753, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 426, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 1.6033, + 4.1779, + 2.0083, + 4.1779, + 2.0083, + 4.2861, + 1.6033, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 430, + "length": 5 + } + }, + { + "content": "Redmond", + "polygon": [ + 3.3454, + 4.1717, + 3.9732, + 4.1717, + 3.9732, + 4.2861, + 3.3454, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 436, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 4.0264, + 4.1789, + 4.2979, + 4.1789, + 4.2979, + 4.3082, + 4.0264, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 444, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 4.3544, + 4.1779, + 4.7594, + 4.1779, + 4.7594, + 4.2861, + 4.3544, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 448, + "length": 5 + } + }, + { + "content": "Redmond", + "polygon": [ + 6.2197, + 4.1717, + 6.8475, + 4.1717, + 6.8475, + 4.2861, + 6.2197, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 454, + "length": 7 + } + }, + { + "content": "WA,", + "polygon": [ + 6.9007, + 4.1789, + 7.1722, + 4.1789, + 7.1722, + 4.3082, + 6.9007, + 4.3082 + ], + "confidence": 1, + "span": { + "offset": 462, + "length": 3 + } + }, + { + "content": "98052", + "polygon": [ + 7.2287, + 4.1779, + 7.6337, + 4.1779, + 7.6337, + 4.2861, + 7.2287, + 4.2861 + ], + "confidence": 1, + "span": { + "offset": 466, + "length": 5 + } + }, + { + "content": "SALESPERSON", + "polygon": [ + 0.7018, + 4.6528, + 1.6092, + 4.6528, + 1.6092, + 4.7529, + 0.7018, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 472, + "length": 11 + } + }, + { + "content": "P.O.", + "polygon": [ + 2.1216, + 4.6528, + 2.3788, + 4.6528, + 2.3788, + 4.7529, + 2.1216, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 484, + "length": 4 + } + }, + { + "content": "NUMBER", + "polygon": [ + 2.4376, + 4.654, + 3.0155, + 4.654, + 3.0155, + 4.7529, + 2.4376, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 489, + "length": 6 + } + }, + { + "content": "REQUISITIONER", + "polygon": [ + 3.4953, + 4.6528, + 4.5157, + 4.6528, + 4.5157, + 4.7687, + 3.4953, + 4.7687 + ], + "confidence": 1, + "span": { + "offset": 496, + "length": 13 + } + }, + { + "content": "SHIPPED", + "polygon": [ + 4.81, + 4.6528, + 5.362, + 4.6528, + 5.362, + 4.7529, + 4.81, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 510, + "length": 7 + } + }, + { + "content": "VIA", + "polygon": [ + 5.409, + 4.654, + 5.6317, + 4.654, + 5.6317, + 4.7517, + 5.409, + 4.7517 + ], + "confidence": 1, + "span": { + "offset": 518, + "length": 3 + } + }, + { + "content": "F.O.B.", + "polygon": [ + 5.8696, + 4.6528, + 6.2467, + 4.6528, + 6.2467, + 4.7529, + 5.8696, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 522, + "length": 6 + } + }, + { + "content": "POINT", + "polygon": [ + 6.3054, + 4.6528, + 6.706, + 4.6528, + 6.706, + 4.7529, + 6.3054, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 529, + "length": 5 + } + }, + { + "content": "TERMS", + "polygon": [ + 7.1806, + 4.6528, + 7.6304, + 4.6528, + 7.6304, + 4.7529, + 7.1806, + 4.7529 + ], + "confidence": 1, + "span": { + "offset": 535, + "length": 5 + } + }, + { + "content": "PO-3333", + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ], + "confidence": 1, + "span": { + "offset": 541, + "length": 7 + } + }, + { + "content": "DATE", + "polygon": [ + 0.7409, + 5.421, + 1.0744, + 5.421, + 1.0744, + 5.5186, + 0.7409, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 549, + "length": 4 + } + }, + { + "content": "ITEM", + "polygon": [ + 1.4213, + 5.421, + 1.7338, + 5.421, + 1.7338, + 5.5186, + 1.4213, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 554, + "length": 4 + } + }, + { + "content": "CODE", + "polygon": [ + 1.7893, + 5.4197, + 2.1407, + 5.4197, + 2.1407, + 5.5199, + 1.7893, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 559, + "length": 4 + } + }, + { + "content": "DESCRIPTION", + "polygon": [ + 2.8516, + 5.4197, + 3.7134, + 5.4197, + 3.7134, + 5.5199, + 2.8516, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 564, + "length": 11 + } + }, + { + "content": "QTY", + "polygon": [ + 4.4043, + 5.4197, + 4.6631, + 5.4197, + 4.6631, + 5.5357, + 4.4043, + 5.5357 + ], + "confidence": 1, + "span": { + "offset": 576, + "length": 3 + } + }, + { + "content": "UM", + "polygon": [ + 5.049, + 5.421, + 5.2654, + 5.421, + 5.2654, + 5.5199, + 5.049, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 580, + "length": 2 + } + }, + { + "content": "PRICE", + "polygon": [ + 5.8563, + 5.4199, + 6.2163, + 5.4199, + 6.2163, + 5.5197, + 5.8563, + 5.5197 + ], + "confidence": 1, + "span": { + "offset": 583, + "length": 5 + } + }, + { + "content": "TAX", + "polygon": [ + 6.7169, + 5.421, + 6.974, + 5.421, + 6.974, + 5.5186, + 6.7169, + 5.5186 + ], + "confidence": 1, + "span": { + "offset": 589, + "length": 3 + } + }, + { + "content": "AMOUNT", + "polygon": [ + 7.2847, + 5.4197, + 7.9039, + 5.4197, + 7.9039, + 5.5199, + 7.2847, + 5.5199 + ], + "confidence": 1, + "span": { + "offset": 593, + "length": 6 + } + }, + { + "content": "3/4/2021", + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ], + "confidence": 1, + "span": { + "offset": 600, + "length": 8 + } + }, + { + "content": "A123", + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 609, + "length": 4 + } + }, + { + "content": "Consulting", + "polygon": [ + 2.3388, + 5.6883, + 3.0438, + 5.6883, + 3.0438, + 5.8312, + 2.3388, + 5.8312 + ], + "confidence": 1, + "span": { + "offset": 614, + "length": 10 + } + }, + { + "content": "Services", + "polygon": [ + 3.0925, + 5.6937, + 3.6278, + 5.6937, + 3.6278, + 5.803, + 3.0925, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 625, + "length": 8 + } + }, + { + "content": "2", + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ], + "confidence": 1, + "span": { + "offset": 634, + "length": 1 + } + }, + { + "content": "hours", + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ], + "confidence": 1, + "span": { + "offset": 636, + "length": 5 + } + }, + { + "content": "$30.00", + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ], + "confidence": 1, + "span": { + "offset": 642, + "length": 6 + } + }, + { + "content": "10%", + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ], + "confidence": 1, + "span": { + "offset": 649, + "length": 3 + } + }, + { + "content": "$60.00", + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ], + "confidence": 1, + "span": { + "offset": 653, + "length": 6 + } + }, + { + "content": "3/5/2021", + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ], + "confidence": 1, + "span": { + "offset": 660, + "length": 8 + } + }, + { + "content": "B456", + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 669, + "length": 4 + } + }, + { + "content": "Document", + "polygon": [ + 2.345, + 5.993, + 3.0318, + 5.993, + 3.0318, + 6.0997, + 2.345, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 674, + "length": 8 + } + }, + { + "content": "Fee", + "polygon": [ + 3.0887, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 3.0887, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 683, + "length": 3 + } + }, + { + "content": "3", + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ], + "confidence": 1, + "span": { + "offset": 687, + "length": 1 + } + }, + { + "content": "$10.00", + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ], + "confidence": 1, + "span": { + "offset": 689, + "length": 6 + } + }, + { + "content": "5%", + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ], + "confidence": 1, + "span": { + "offset": 696, + "length": 2 + } + }, + { + "content": "$30.00", + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ], + "confidence": 1, + "span": { + "offset": 699, + "length": 6 + } + }, + { + "content": "3/6/2021", + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ], + "confidence": 1, + "span": { + "offset": 706, + "length": 8 + } + }, + { + "content": "C789", + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 715, + "length": 4 + } + }, + { + "content": "Printing", + "polygon": [ + 2.345, + 6.2906, + 2.8575, + 6.2906, + 2.8575, + 6.4281, + 2.345, + 6.4281 + ], + "confidence": 1, + "span": { + "offset": 720, + "length": 8 + } + }, + { + "content": "Fee", + "polygon": [ + 2.9143, + 6.2933, + 3.1351, + 6.2933, + 3.1351, + 6.3999, + 2.9143, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 729, + "length": 3 + } + }, + { + "content": "10", + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ], + "confidence": 1, + "span": { + "offset": 733, + "length": 2 + } + }, + { + "content": "pages", + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ], + "confidence": 1, + "span": { + "offset": 736, + "length": 5 + } + }, + { + "content": "$1.00", + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ], + "confidence": 1, + "span": { + "offset": 742, + "length": 5 + } + }, + { + "content": "20%", + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ], + "confidence": 1, + "span": { + "offset": 748, + "length": 3 + } + }, + { + "content": "$10.00", + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ], + "confidence": 1, + "span": { + "offset": 752, + "length": 6 + } + }, + { + "content": "SUBTOTAL", + "polygon": [ + 6.0282, + 6.9118, + 6.7309, + 6.9118, + 6.7309, + 7.0199, + 6.0282, + 7.0199 + ], + "confidence": 1, + "span": { + "offset": 759, + "length": 8 + } + }, + { + "content": "$100.00", + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ], + "confidence": 1, + "span": { + "offset": 768, + "length": 7 + } + }, + { + "content": "SALES", + "polygon": [ + 6.0382, + 7.2089, + 6.4262, + 7.2089, + 6.4262, + 7.317, + 6.0382, + 7.317 + ], + "confidence": 1, + "span": { + "offset": 776, + "length": 5 + } + }, + { + "content": "TAX", + "polygon": [ + 6.4702, + 7.2099, + 6.728, + 7.2099, + 6.728, + 7.316, + 6.4702, + 7.316 + ], + "confidence": 1, + "span": { + "offset": 782, + "length": 3 + } + }, + { + "content": "$10.00", + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ], + "confidence": 1, + "span": { + "offset": 786, + "length": 6 + } + }, + { + "content": "TOTAL", + "polygon": [ + 6.2969, + 7.5089, + 6.7309, + 7.5089, + 6.7309, + 7.617, + 6.2969, + 7.617 + ], + "confidence": 1, + "span": { + "offset": 793, + "length": 5 + } + }, + { + "content": "$110.00", + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ], + "confidence": 1, + "span": { + "offset": 799, + "length": 7 + } + }, + { + "content": "PREVIOUS", + "polygon": [ + 4.8126, + 7.8055, + 5.4789, + 7.8055, + 5.4789, + 7.9137, + 4.8126, + 7.9137 + ], + "confidence": 1, + "span": { + "offset": 807, + "length": 8 + } + }, + { + "content": "UNPAID", + "polygon": [ + 5.5362, + 7.8065, + 6.057, + 7.8065, + 6.057, + 7.9137, + 5.5362, + 7.9137 + ], + "confidence": 1, + "span": { + "offset": 816, + "length": 6 + } + }, + { + "content": "BALANCE", + "polygon": [ + 6.1164, + 7.8057, + 6.7249, + 7.8057, + 6.7249, + 7.9135, + 6.1164, + 7.9135 + ], + "confidence": 1, + "span": { + "offset": 823, + "length": 7 + } + }, + { + "content": "$500.00", + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ], + "confidence": 1, + "span": { + "offset": 831, + "length": 7 + } + }, + { + "content": "AMOUNT", + "polygon": [ + 5.7652, + 8.1022, + 6.4055, + 8.1022, + 6.4055, + 8.2104, + 5.7652, + 8.2104 + ], + "confidence": 1, + "span": { + "offset": 839, + "length": 6 + } + }, + { + "content": "DUE", + "polygon": [ + 6.4562, + 8.1032, + 6.725, + 8.1032, + 6.725, + 8.2104, + 6.4562, + 8.2104 + ], + "confidence": 1, + "span": { + "offset": 846, + "length": 3 + } + }, + { + "content": "$610.00", + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ], + "confidence": 1, + "span": { + "offset": 850, + "length": 7 + } + }, + { + "content": "THANK", + "polygon": [ + 3.129, + 8.5453, + 3.5887, + 8.5453, + 3.5887, + 8.6429, + 3.129, + 8.6429 + ], + "confidence": 1, + "span": { + "offset": 858, + "length": 5 + } + }, + { + "content": "YOU", + "polygon": [ + 3.6316, + 8.544, + 3.9064, + 8.544, + 3.9064, + 8.6442, + 3.6316, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 864, + "length": 3 + } + }, + { + "content": "FOR", + "polygon": [ + 3.9671, + 8.544, + 4.2187, + 8.544, + 4.2187, + 8.6442, + 3.9671, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 868, + "length": 3 + } + }, + { + "content": "YOUR", + "polygon": [ + 4.2638, + 8.544, + 4.6347, + 8.544, + 4.6347, + 8.6442, + 4.2638, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 872, + "length": 4 + } + }, + { + "content": "BUSINESS!", + "polygon": [ + 4.6859, + 8.539, + 5.356, + 8.539, + 5.356, + 8.6442, + 4.6859, + 8.6442 + ], + "confidence": 1, + "span": { + "offset": 877, + "length": 9 + } + }, + { + "content": "REMIT", + "polygon": [ + 0.5909, + 9.1619, + 1.0014, + 9.1619, + 1.0014, + 9.2596, + 0.5909, + 9.2596 + ], + "confidence": 1, + "span": { + "offset": 887, + "length": 5 + } + }, + { + "content": "TO:", + "polygon": [ + 1.0446, + 9.1607, + 1.2603, + 9.1607, + 1.2603, + 9.2608, + 1.0446, + 9.2608 + ], + "confidence": 1, + "span": { + "offset": 893, + "length": 3 + } + }, + { + "content": "Contoso", + "polygon": [ + 0.5882, + 9.3697, + 1.1337, + 9.3697, + 1.1337, + 9.4777, + 0.5882, + 9.4777 + ], + "confidence": 1, + "span": { + "offset": 897, + "length": 7 + } + }, + { + "content": "Billing", + "polygon": [ + 1.1905, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 1.1905, + 9.5059 + ], + "confidence": 1, + "span": { + "offset": 905, + "length": 7 + } + }, + { + "content": "123", + "polygon": [ + 0.5945, + 9.5728, + 0.8213, + 9.5728, + 0.8213, + 9.681, + 0.5945, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 913, + "length": 3 + } + }, + { + "content": "Remit", + "polygon": [ + 0.881, + 9.5717, + 1.264, + 9.5717, + 1.264, + 9.681, + 0.881, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 917, + "length": 5 + } + }, + { + "content": "St", + "polygon": [ + 1.3125, + 9.5728, + 1.4337, + 9.5728, + 1.4337, + 9.681, + 1.3125, + 9.681 + ], + "confidence": 1, + "span": { + "offset": 923, + "length": 2 + } + }, + { + "content": "New", + "polygon": [ + 0.5943, + 9.7808, + 0.8848, + 9.7808, + 0.8848, + 9.8877, + 0.5943, + 9.8877 + ], + "confidence": 1, + "span": { + "offset": 926, + "length": 3 + } + }, + { + "content": "York,", + "polygon": [ + 0.9293, + 9.773, + 1.2568, + 9.773, + 1.2568, + 9.9098, + 0.9293, + 9.9098 + ], + "confidence": 1, + "span": { + "offset": 930, + "length": 5 + } + }, + { + "content": "NY,", + "polygon": [ + 1.3205, + 9.7805, + 1.5233, + 9.7805, + 1.5233, + 9.9098, + 1.3205, + 9.9098 + ], + "confidence": 1, + "span": { + "offset": 936, + "length": 3 + } + }, + { + "content": "10001", + "polygon": [ + 1.5903, + 9.7795, + 1.9882, + 9.7795, + 1.9882, + 9.8877, + 1.5903, + 9.8877 + ], + "confidence": 1, + "span": { + "offset": 940, + "length": 5 + } + } + ], + "selectionMarks": [ + { + "state": "unselected", + "polygon": [ + 4.3231, + 5.6279, + 4.7562, + 5.6279, + 4.7562, + 5.8654, + 4.3231, + 5.8654 + ], + "confidence": 0.212, + "span": { + "offset": 946, + "length": 12 + } + } + ], + "lines": [ + { + "content": "CONTOSO LTD.", + "polygon": [ + 0.5911, + 0.6857, + 2.3181, + 0.6857, + 2.3181, + 0.8664, + 0.5911, + 0.8664 + ], + "spans": [ + { + "offset": 0, + "length": 12 + } + ] + }, + { + "content": "INVOICE", + "polygon": [ + 7.0751, + 0.589, + 7.9886, + 0.589, + 7.9886, + 0.7697, + 7.0751, + 0.7697 + ], + "spans": [ + { + "offset": 13, + "length": 7 + } + ] + }, + { + "content": "Contoso Headquarters", + "polygon": [ + 0.5882, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 0.5882, + 1.5664 + ], + "spans": [ + { + "offset": 21, + "length": 20 + } + ] + }, + { + "content": "INVOICE: INV-100", + "polygon": [ + 6.8599, + 1.4217, + 7.9988, + 1.4217, + 7.9988, + 1.5218, + 6.8599, + 1.5218 + ], + "spans": [ + { + "offset": 42, + "length": 16 + } + ] + }, + { + "content": "123 456th St", + "polygon": [ + 0.5945, + 1.6092, + 1.3812, + 1.6092, + 1.3812, + 1.742, + 0.5945, + 1.742 + ], + "spans": [ + { + "offset": 59, + "length": 12 + } + ] + }, + { + "content": "INVOICE DATE: 11/15/2019", + "polygon": [ + 6.2263, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 6.2263, + 1.7449 + ], + "spans": [ + { + "offset": 72, + "length": 24 + } + ] + }, + { + "content": "New York, NY, 10001", + "polygon": [ + 0.5943, + 1.8307, + 1.9894, + 1.8307, + 1.9894, + 1.9675, + 0.5943, + 1.9675 + ], + "spans": [ + { + "offset": 97, + "length": 19 + } + ] + }, + { + "content": "DUE DATE: 12/15/2019", + "polygon": [ + 6.4966, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 6.4966, + 1.9515 + ], + "spans": [ + { + "offset": 117, + "length": 20 + } + ] + }, + { + "content": "CUSTOMER NAME: MICROSOFT CORPORATION", + "polygon": [ + 4.9513, + 2.0388, + 7.9825, + 2.0388, + 7.9825, + 2.1389, + 4.9513, + 2.1389 + ], + "spans": [ + { + "offset": 138, + "length": 36 + } + ] + }, + { + "content": "SERVICE PERIOD: 10/14/2019 – 11/14/2019", + "polygon": [ + 5.1667, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 5.1667, + 2.3615 + ], + "spans": [ + { + "offset": 175, + "length": 39 + } + ] + }, + { + "content": "CUSTOMER ID: CID-12345", + "polygon": [ + 6.3253, + 2.4488, + 7.9951, + 2.4488, + 7.9951, + 2.5489, + 6.3253, + 2.5489 + ], + "spans": [ + { + "offset": 215, + "length": 22 + } + ] + }, + { + "content": "Microsoft Corp", + "polygon": [ + 0.5943, + 2.6436, + 1.586, + 2.6436, + 1.586, + 2.7871, + 0.5943, + 2.7871 + ], + "spans": [ + { + "offset": 238, + "length": 14 + } + ] + }, + { + "content": "123 Other St,", + "polygon": [ + 0.5945, + 2.8476, + 1.4633, + 2.8476, + 1.4633, + 2.9845, + 0.5945, + 2.9845 + ], + "spans": [ + { + "offset": 253, + "length": 13 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 0.5943, + 3.0513, + 2.0083, + 3.0513, + 2.0083, + 3.1878, + 0.5943, + 3.1878 + ], + "spans": [ + { + "offset": 267, + "length": 17 + } + ] + }, + { + "content": "BILL TO:", + "polygon": [ + 0.5909, + 3.559, + 1.1032, + 3.559, + 1.1032, + 3.6592, + 0.5909, + 3.6592 + ], + "spans": [ + { + "offset": 285, + "length": 8 + } + ] + }, + { + "content": "SHIP TO:", + "polygon": [ + 3.3361, + 3.559, + 3.8903, + 3.559, + 3.8903, + 3.6592, + 3.3361, + 3.6592 + ], + "spans": [ + { + "offset": 294, + "length": 8 + } + ] + }, + { + "content": "SERVICE ADDRESS:", + "polygon": [ + 6.2104, + 3.559, + 7.4232, + 3.559, + 7.4232, + 3.6592, + 6.2104, + 3.6592 + ], + "spans": [ + { + "offset": 303, + "length": 16 + } + ] + }, + { + "content": "Microsoft Finance", + "polygon": [ + 0.5943, + 3.7641, + 1.7878, + 3.7641, + 1.7878, + 3.8794, + 0.5943, + 3.8794 + ], + "spans": [ + { + "offset": 320, + "length": 17 + } + ] + }, + { + "content": "Microsoft Delivery", + "polygon": [ + 3.3454, + 3.7641, + 4.5762, + 3.7641, + 4.5762, + 3.9076, + 3.3454, + 3.9076 + ], + "spans": [ + { + "offset": 338, + "length": 18 + } + ] + }, + { + "content": "Microsoft Services", + "polygon": [ + 6.2197, + 3.7641, + 7.4427, + 3.7641, + 7.4427, + 3.8794, + 6.2197, + 3.8794 + ], + "spans": [ + { + "offset": 357, + "length": 18 + } + ] + }, + { + "content": "123 Bill St,", + "polygon": [ + 0.5945, + 3.9681, + 1.2765, + 3.9681, + 1.2765, + 4.1049, + 0.5945, + 4.1049 + ], + "spans": [ + { + "offset": 376, + "length": 12 + } + ] + }, + { + "content": "123 Ship St,", + "polygon": [ + 3.3456, + 3.9681, + 4.1111, + 3.9681, + 4.1111, + 4.1109, + 3.3456, + 4.1109 + ], + "spans": [ + { + "offset": 389, + "length": 12 + } + ] + }, + { + "content": "123 Service St,", + "polygon": [ + 6.2199, + 3.9734, + 7.1821, + 3.9734, + 7.1821, + 4.1049, + 6.2199, + 4.1049 + ], + "spans": [ + { + "offset": 402, + "length": 15 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 0.5943, + 4.1717, + 2.0083, + 4.1717, + 2.0083, + 4.3082, + 0.5943, + 4.3082 + ], + "spans": [ + { + "offset": 418, + "length": 17 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 3.3454, + 4.1717, + 4.7594, + 4.1717, + 4.7594, + 4.3082, + 3.3454, + 4.3082 + ], + "spans": [ + { + "offset": 436, + "length": 17 + } + ] + }, + { + "content": "Redmond WA, 98052", + "polygon": [ + 6.2197, + 4.1717, + 7.6337, + 4.1717, + 7.6337, + 4.3082, + 6.2197, + 4.3082 + ], + "spans": [ + { + "offset": 454, + "length": 17 + } + ] + }, + { + "content": "SALESPERSON", + "polygon": [ + 0.7018, + 4.6528, + 1.6092, + 4.6528, + 1.6092, + 4.7529, + 0.7018, + 4.7529 + ], + "spans": [ + { + "offset": 472, + "length": 11 + } + ] + }, + { + "content": "P.O. NUMBER", + "polygon": [ + 2.1216, + 4.6528, + 3.0155, + 4.6528, + 3.0155, + 4.7529, + 2.1216, + 4.7529 + ], + "spans": [ + { + "offset": 484, + "length": 11 + } + ] + }, + { + "content": "REQUISITIONER", + "polygon": [ + 3.4953, + 4.6528, + 4.5157, + 4.6528, + 4.5157, + 4.7687, + 3.4953, + 4.7687 + ], + "spans": [ + { + "offset": 496, + "length": 13 + } + ] + }, + { + "content": "SHIPPED VIA", + "polygon": [ + 4.81, + 4.6528, + 5.6317, + 4.6528, + 5.6317, + 4.7529, + 4.81, + 4.7529 + ], + "spans": [ + { + "offset": 510, + "length": 11 + } + ] + }, + { + "content": "F.O.B. POINT", + "polygon": [ + 5.8696, + 4.6528, + 6.706, + 4.6528, + 6.706, + 4.7529, + 5.8696, + 4.7529 + ], + "spans": [ + { + "offset": 522, + "length": 12 + } + ] + }, + { + "content": "TERMS", + "polygon": [ + 7.1806, + 4.6528, + 7.6304, + 4.6528, + 7.6304, + 4.7529, + 7.1806, + 4.7529 + ], + "spans": [ + { + "offset": 535, + "length": 5 + } + ] + }, + { + "content": "PO-3333", + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ], + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + { + "content": "DATE", + "polygon": [ + 0.7409, + 5.421, + 1.0744, + 5.421, + 1.0744, + 5.5186, + 0.7409, + 5.5186 + ], + "spans": [ + { + "offset": 549, + "length": 4 + } + ] + }, + { + "content": "ITEM CODE", + "polygon": [ + 1.4213, + 5.4197, + 2.1407, + 5.4197, + 2.1407, + 5.5199, + 1.4213, + 5.5199 + ], + "spans": [ + { + "offset": 554, + "length": 9 + } + ] + }, + { + "content": "DESCRIPTION", + "polygon": [ + 2.8516, + 5.4197, + 3.7134, + 5.4197, + 3.7134, + 5.5199, + 2.8516, + 5.5199 + ], + "spans": [ + { + "offset": 564, + "length": 11 + } + ] + }, + { + "content": "QTY", + "polygon": [ + 4.4043, + 5.4197, + 4.6631, + 5.4197, + 4.6631, + 5.5357, + 4.4043, + 5.5357 + ], + "spans": [ + { + "offset": 576, + "length": 3 + } + ] + }, + { + "content": "UM", + "polygon": [ + 5.049, + 5.421, + 5.2654, + 5.421, + 5.2654, + 5.5199, + 5.049, + 5.5199 + ], + "spans": [ + { + "offset": 580, + "length": 2 + } + ] + }, + { + "content": "PRICE", + "polygon": [ + 5.8563, + 5.4199, + 6.2163, + 5.4199, + 6.2163, + 5.5197, + 5.8563, + 5.5197 + ], + "spans": [ + { + "offset": 583, + "length": 5 + } + ] + }, + { + "content": "TAX", + "polygon": [ + 6.7169, + 5.421, + 6.974, + 5.421, + 6.974, + 5.5186, + 6.7169, + 5.5186 + ], + "spans": [ + { + "offset": 589, + "length": 3 + } + ] + }, + { + "content": "AMOUNT", + "polygon": [ + 7.2847, + 5.4197, + 7.9039, + 5.4197, + 7.9039, + 5.5199, + 7.2847, + 5.5199 + ], + "spans": [ + { + "offset": 593, + "length": 6 + } + ] + }, + { + "content": "3/4/2021", + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ], + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + { + "content": "A123", + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ], + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + { + "content": "Consulting Services", + "polygon": [ + 2.3388, + 5.6883, + 3.6278, + 5.6883, + 3.6278, + 5.8312, + 2.3388, + 5.8312 + ], + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + { + "content": "2", + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ], + "spans": [ + { + "offset": 634, + "length": 1 + } + ] + }, + { + "content": "hours", + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ], + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + { + "content": "$30.00", + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ], + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + }, + { + "content": "10%", + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ], + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + { + "content": "$60.00", + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ], + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + { + "content": "3/5/2021", + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ], + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + { + "content": "B456", + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ], + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + { + "content": "Document Fee", + "polygon": [ + 2.345, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 2.345, + 6.0997 + ], + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + { + "content": "3", + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ], + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ], + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + }, + { + "content": "5%", + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ], + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + { + "content": "$30.00", + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ], + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + { + "content": "3/6/2021", + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ], + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + { + "content": "C789", + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ], + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + { + "content": "Printing Fee", + "polygon": [ + 2.345, + 6.2906, + 3.1351, + 6.2906, + 3.1351, + 6.4281, + 2.345, + 6.4281 + ], + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + { + "content": "10", + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ], + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + { + "content": "pages", + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ], + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + { + "content": "$1.00", + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ], + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + }, + { + "content": "20%", + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ], + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ], + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + }, + { + "content": "SUBTOTAL", + "polygon": [ + 6.0282, + 6.9118, + 6.7309, + 6.9118, + 6.7309, + 7.0199, + 6.0282, + 7.0199 + ], + "spans": [ + { + "offset": 759, + "length": 8 + } + ] + }, + { + "content": "$100.00", + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ], + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + { + "content": "SALES TAX", + "polygon": [ + 6.0382, + 7.2089, + 6.728, + 7.2089, + 6.728, + 7.317, + 6.0382, + 7.317 + ], + "spans": [ + { + "offset": 776, + "length": 9 + } + ] + }, + { + "content": "$10.00", + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ], + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + { + "content": "TOTAL", + "polygon": [ + 6.2969, + 7.5089, + 6.7309, + 7.5089, + 6.7309, + 7.617, + 6.2969, + 7.617 + ], + "spans": [ + { + "offset": 793, + "length": 5 + } + ] + }, + { + "content": "$110.00", + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ], + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + { + "content": "PREVIOUS UNPAID BALANCE", + "polygon": [ + 4.8126, + 7.8055, + 6.7249, + 7.8055, + 6.7249, + 7.9137, + 4.8126, + 7.9137 + ], + "spans": [ + { + "offset": 807, + "length": 23 + } + ] + }, + { + "content": "$500.00", + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ], + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + { + "content": "AMOUNT DUE", + "polygon": [ + 5.7652, + 8.1022, + 6.725, + 8.1022, + 6.725, + 8.2104, + 5.7652, + 8.2104 + ], + "spans": [ + { + "offset": 839, + "length": 10 + } + ] + }, + { + "content": "$610.00", + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ], + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + }, + { + "content": "THANK YOU FOR YOUR BUSINESS!", + "polygon": [ + 3.129, + 8.539, + 5.356, + 8.539, + 5.356, + 8.6442, + 3.129, + 8.6442 + ], + "spans": [ + { + "offset": 858, + "length": 28 + } + ] + }, + { + "content": "REMIT TO:", + "polygon": [ + 0.5909, + 9.1607, + 1.2603, + 9.1607, + 1.2603, + 9.2608, + 0.5909, + 9.2608 + ], + "spans": [ + { + "offset": 887, + "length": 9 + } + ] + }, + { + "content": "Contoso Billing", + "polygon": [ + 0.5882, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 0.5882, + 9.5059 + ], + "spans": [ + { + "offset": 897, + "length": 15 + } + ] + }, + { + "content": "123 Remit St", + "polygon": [ + 0.5945, + 9.5717, + 1.4337, + 9.5717, + 1.4337, + 9.681, + 0.5945, + 9.681 + ], + "spans": [ + { + "offset": 913, + "length": 12 + } + ] + }, + { + "content": "New York, NY, 10001", + "polygon": [ + 0.5943, + 9.773, + 1.9882, + 9.773, + 1.9882, + 9.9098, + 0.5943, + 9.9098 + ], + "spans": [ + { + "offset": 926, + "length": 19 + } + ] + } + ], + "spans": [ + { + "offset": 0, + "length": 958 + } + ] + } + ], + "tables": [ + { + "rowCount": 4, + "columnCount": 8, + "cells": [ + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "DATE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4932, + 5.329, + 1.3011, + 5.3213, + 1.3011, + 5.6056, + 0.5009, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 549, + "length": 4 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "ITEM CODE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.3213, + 2.2476, + 5.3213, + 2.2399, + 5.6056, + 1.3011, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 554, + "length": 9 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "DESCRIPTION", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2476, + 5.3213, + 4.3174, + 5.329, + 4.3097, + 5.6056, + 2.2399, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 564, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "QTY", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3174, + 5.329, + 4.7483, + 5.329, + 4.7483, + 5.6056, + 4.3097, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 576, + "length": 3 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "UM", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.329, + 5.5639, + 5.329, + 5.5639, + 5.6056, + 4.7483, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 580, + "length": 2 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "PRICE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.329, + 6.495, + 5.329, + 6.495, + 5.6056, + 5.5639, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 583, + "length": 5 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "TAX", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.329, + 7.1875, + 5.329, + 7.1952, + 5.6056, + 6.495, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 589, + "length": 3 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "AMOUNT", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1875, + 5.329, + 7.9954, + 5.329, + 7.9954, + 5.598, + 7.1952, + 5.6056 + ] + } + ], + "spans": [ + { + "offset": 593, + "length": 6 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/4/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5009, + 5.6056, + 1.3011, + 5.6056, + 1.3011, + 5.8976, + 0.5009, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "A123", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.6056, + 2.2399, + 5.6056, + 2.2322, + 5.8976, + 1.3011, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Consulting Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2399, + 5.6056, + 4.3097, + 5.6056, + 4.3097, + 5.8976, + 2.2322, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "2 :unselected:", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 5.6056, + 4.7483, + 5.6056, + 4.7483, + 5.8976, + 4.3097, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 634, + "length": 1 + }, + { + "offset": 946, + "length": 12 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "hours", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.6056, + 5.5639, + 5.6056, + 5.5639, + 5.8976, + 4.7483, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.6056, + 6.495, + 5.6056, + 6.495, + 5.8976, + 5.5639, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "10%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.6056, + 7.1952, + 5.6056, + 7.1952, + 5.8976, + 6.495, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 5.6056, + 7.9954, + 5.598, + 7.9954, + 5.9053, + 7.1952, + 5.8976 + ] + } + ], + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/5/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5009, + 5.8976, + 1.3011, + 5.8976, + 1.3011, + 6.1973, + 0.5086, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "B456", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 5.8976, + 2.2322, + 5.8976, + 2.2245, + 6.1973, + 1.3011, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Document Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2322, + 5.8976, + 4.3097, + 5.8976, + 4.3097, + 6.1973, + 2.2245, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "3", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 5.8976, + 4.7483, + 5.8976, + 4.7483, + 6.1973, + 4.3097, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 5.8976, + 5.5639, + 5.8976, + 5.5639, + 6.1973, + 4.7483, + 6.1973 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 2, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 5.8976, + 6.495, + 5.8976, + 6.495, + 6.1973, + 5.5639, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "5%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 5.8976, + 7.1952, + 5.8976, + 7.1952, + 6.1973, + 6.495, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 5.8976, + 7.9954, + 5.9053, + 7.9954, + 6.1896, + 7.1952, + 6.1973 + ] + } + ], + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "3/6/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5086, + 6.1973, + 1.3011, + 6.1973, + 1.3011, + 6.4969, + 0.5086, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "C789", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.3011, + 6.1973, + 2.2245, + 6.1973, + 2.2245, + 6.4969, + 1.3011, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "Printing Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.2245, + 6.1973, + 4.3097, + 6.1973, + 4.3097, + 6.4969, + 2.2245, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "10", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.3097, + 6.1973, + 4.7483, + 6.1973, + 4.7483, + 6.4969, + 4.3097, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "pages", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7483, + 6.1973, + 5.5639, + 6.1973, + 5.5639, + 6.4969, + 4.7483, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "$1.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.5639, + 6.1973, + 6.495, + 6.1973, + 6.495, + 6.4969, + 5.5639, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 6, + "rowSpan": 1, + "columnSpan": 1, + "content": "20%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.495, + 6.1973, + 7.1952, + 6.1973, + 7.1952, + 6.4969, + 6.495, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 7, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.1952, + 6.1973, + 7.9954, + 6.1896, + 7.9954, + 6.5046, + 7.1952, + 6.4969 + ] + } + ], + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4901, + 5.3293, + 7.9946, + 5.3289, + 7.9954, + 6.5019, + 0.4906, + 6.502 + ] + } + ], + "spans": [ + { + "offset": 549, + "length": 209 + }, + { + "offset": 946, + "length": 12 + } + ] + }, + { + "rowCount": 2, + "columnCount": 6, + "cells": [ + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SALESPERSON", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4977, + 4.565, + 1.8042, + 4.565, + 1.8119, + 4.8388, + 0.5054, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 472, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "P.O. NUMBER", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.8042, + 4.565, + 3.3105, + 4.565, + 3.3105, + 4.8388, + 1.8119, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 484, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "REQUISITIONER", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3105, + 4.565, + 4.6939, + 4.565, + 4.6862, + 4.8388, + 3.3105, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 496, + "length": 13 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "SHIPPED VIA", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.6939, + 4.565, + 5.7468, + 4.565, + 5.7468, + 4.8388, + 4.6862, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 510, + "length": 11 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "F.O.B. POINT", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.7468, + 4.565, + 6.815, + 4.565, + 6.815, + 4.8388, + 5.7468, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 522, + "length": 12 + } + ] + }, + { + "kind": "columnHeader", + "rowIndex": 0, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "TERMS", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.815, + 4.565, + 7.9985, + 4.565, + 7.9985, + 4.8388, + 6.815, + 4.8388 + ] + } + ], + "spans": [ + { + "offset": 535, + "length": 5 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5054, + 4.8388, + 1.8119, + 4.8388, + 1.8119, + 5.1058, + 0.5131, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "PO-3333", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.8119, + 4.8388, + 3.3105, + 4.8388, + 3.3105, + 5.1058, + 1.8119, + 5.1058 + ] + } + ], + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 2, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3105, + 4.8388, + 4.6862, + 4.8388, + 4.6862, + 5.1058, + 3.3105, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 3, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.6862, + 4.8388, + 5.7468, + 4.8388, + 5.7468, + 5.1058, + 4.6862, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 4, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.7468, + 4.8388, + 6.815, + 4.8388, + 6.815, + 5.1058, + 5.7468, + 5.1058 + ] + } + ], + "spans": [] + }, + { + "rowIndex": 1, + "columnIndex": 5, + "rowSpan": 1, + "columnSpan": 1, + "content": "", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.815, + 4.8388, + 7.9985, + 4.8388, + 7.9985, + 5.1125, + 6.815, + 5.1058 + ] + } + ], + "spans": [] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.4971, + 4.565, + 7.9889, + 4.5653, + 7.989, + 5.1146, + 0.4963, + 5.1141 + ] + } + ], + "spans": [ + { + "offset": 472, + "length": 76 + } + ] + }, + { + "rowCount": 5, + "columnCount": 2, + "cells": [ + { + "rowIndex": 0, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SUBTOTAL", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7474, + 6.7934, + 6.8058, + 6.7934, + 6.8105, + 7.0886, + 4.7474, + 7.0886 + ] + } + ], + "spans": [ + { + "offset": 759, + "length": 8 + } + ] + }, + { + "rowIndex": 0, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$100.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8058, + 6.7934, + 7.9981, + 6.7934, + 7.9981, + 7.0934, + 6.8105, + 7.0886 + ] + } + ], + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "SALES TAX", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7474, + 7.0886, + 6.8105, + 7.0886, + 6.8105, + 7.3743, + 4.7427, + 7.3743 + ] + } + ], + "spans": [ + { + "offset": 776, + "length": 9 + } + ] + }, + { + "rowIndex": 1, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.0886, + 7.9981, + 7.0934, + 7.9981, + 7.3934, + 6.8105, + 7.3743 + ] + } + ], + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "TOTAL", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.3743, + 6.8105, + 7.3743, + 6.8105, + 7.6839, + 4.7427, + 7.6839 + ] + } + ], + "spans": [ + { + "offset": 793, + "length": 5 + } + ] + }, + { + "rowIndex": 2, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$110.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.3743, + 7.9981, + 7.3934, + 7.9981, + 7.6886, + 6.8105, + 7.6839 + ] + } + ], + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "PREVIOUS UNPAID BALANCE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.6839, + 6.8105, + 7.6839, + 6.8105, + 7.9743, + 4.7427, + 7.9743 + ] + } + ], + "spans": [ + { + "offset": 807, + "length": 23 + } + ] + }, + { + "rowIndex": 3, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$500.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.6839, + 7.9981, + 7.6886, + 7.9981, + 7.9839, + 6.8105, + 7.9743 + ] + } + ], + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + { + "rowIndex": 4, + "columnIndex": 0, + "rowSpan": 1, + "columnSpan": 1, + "content": "AMOUNT DUE", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7427, + 7.9743, + 6.8105, + 7.9743, + 6.8105, + 8.2839, + 4.7381, + 8.2839 + ] + } + ], + "spans": [ + { + "offset": 839, + "length": 10 + } + ] + }, + { + "rowIndex": 4, + "columnIndex": 1, + "rowSpan": 1, + "columnSpan": 1, + "content": "$610.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.8105, + 7.9743, + 7.9981, + 7.9839, + 7.9981, + 8.2839, + 6.8105, + 8.2839 + ] + } + ], + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + } + ], + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.7456, + 6.7793, + 8.0143, + 6.7788, + 8.0137, + 8.2981, + 4.7446, + 8.2981 + ] + } + ], + "spans": [ + { + "offset": 759, + "length": 98 + } + ] + } + ], + "documents": [ + { + "docType": "prebuilt:invoice", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "fields": { + "AmountDue": { + "type": "number", + "valueNumber": 610, + "content": "$610.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 8.0584, + 7.9181, + 8.0584, + 7.9181, + 8.2022, + 7.3842, + 8.2022 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 850, + "length": 7 + } + ] + }, + "BillingAddress": { + "type": "string", + "valueString": "123 Bill St, Redmond WA, 98052", + "content": "123 Bill St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 3.9681, + 2.0083, + 3.9681, + 2.0083, + 4.3082, + 0.5943, + 4.3082 + ] + } + ], + "confidence": 0.947, + "spans": [ + { + "offset": 376, + "length": 12 + }, + { + "offset": 418, + "length": 17 + } + ] + }, + "BillingAddressRecipient": { + "type": "string", + "valueString": "Microsoft Finance", + "content": "Microsoft Finance", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 3.7641, + 1.7878, + 3.7641, + 1.7878, + 3.8794, + 0.5943, + 3.8794 + ] + } + ], + "confidence": 0.957, + "spans": [ + { + "offset": 320, + "length": 17 + } + ] + }, + "CustomerAddress": { + "type": "string", + "valueString": "123 Other St, Redmond WA, 98052", + "content": "123 Other St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 2.8476, + 2.0083, + 2.8476, + 2.0083, + 3.1878, + 0.5943, + 3.1878 + ] + } + ], + "confidence": 0.947, + "spans": [ + { + "offset": 253, + "length": 31 + } + ] + }, + "CustomerAddressRecipient": { + "type": "string", + "valueString": "Microsoft Corp", + "content": "Microsoft Corp", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 2.6436, + 1.586, + 2.6436, + 1.586, + 2.7871, + 0.5943, + 2.7871 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 238, + "length": 14 + } + ] + }, + "CustomerId": { + "type": "string", + "valueString": "CID-12345", + "content": "CID-12345", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3369, + 2.4491, + 7.9951, + 2.4491, + 7.9951, + 2.5486, + 7.3369, + 2.5486 + ] + } + ], + "confidence": 0.964, + "spans": [ + { + "offset": 228, + "length": 9 + } + ] + }, + "CustomerName": { + "type": "string", + "valueString": "MICROSOFT CORPORATION", + "content": "MICROSOFT CORPORATION", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2419, + 2.0391, + 7.9825, + 2.0391, + 7.9825, + 2.1386, + 6.2419, + 2.1386 + ] + } + ], + "confidence": 0.949, + "spans": [ + { + "offset": 153, + "length": 21 + } + ] + }, + "DueDate": { + "type": "date", + "valueDate": "2019-12-15", + "content": "12/15/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2494, + 1.8206, + 7.993, + 1.8206, + 7.993, + 1.9515, + 7.2494, + 1.9515 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 127, + "length": 10 + } + ] + }, + "InvoiceDate": { + "type": "date", + "valueDate": "2019-11-15", + "content": "11/15/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2528, + 1.6139, + 7.993, + 1.6139, + 7.993, + 1.7449, + 7.2528, + 1.7449 + ] + } + ], + "confidence": 0.972, + "spans": [ + { + "offset": 86, + "length": 10 + } + ] + }, + "InvoiceId": { + "type": "string", + "valueString": "INV-100", + "content": "INV-100", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4959, + 1.422, + 7.9988, + 1.422, + 7.9988, + 1.5215, + 7.4959, + 1.5215 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 51, + "length": 7 + } + ] + }, + "InvoiceTotal": { + "type": "number", + "valueNumber": 110, + "content": "$110.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 7.465, + 7.9181, + 7.465, + 7.9181, + 7.6089, + 7.3842, + 7.6089 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 799, + "length": 7 + } + ] + }, + "Items": { + "type": "array", + "valueArray": [ + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 60, + "content": "$60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8215, + 7.4642, + 5.8215 + ] + } + ], + "confidence": 0.902, + "spans": [ + { + "offset": 653, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-04", + "content": "3/4/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.682, + 1.2092, + 5.682, + 1.2092, + 5.8243, + 0.592, + 5.8243 + ] + } + ], + "confidence": 0.938, + "spans": [ + { + "offset": 600, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Consulting Services", + "content": "Consulting Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.3388, + 5.6883, + 3.6278, + 5.6883, + 3.6278, + 5.8312, + 2.3388, + 5.8312 + ] + } + ], + "confidence": 0.9, + "spans": [ + { + "offset": 614, + "length": 19 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "A123", + "content": "A123", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6069, + 5.6948, + 1.9417, + 5.6948, + 1.9417, + 5.803, + 1.6069, + 5.803 + ] + } + ], + "confidence": 0.877, + "spans": [ + { + "offset": 609, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 2, + "content": "2", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5977, + 5.6948, + 4.6635, + 5.6948, + 4.6635, + 5.8017, + 4.5977, + 5.8017 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 634, + "length": 1 + } + ] + }, + "Tax": { + "type": "number", + "content": "10%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.7168, + 5.6932, + 6.9826, + 5.6932, + 6.9826, + 5.8045, + 6.7168, + 5.8045 + ] + } + ], + "confidence": 0.78, + "spans": [ + { + "offset": 649, + "length": 3 + } + ] + }, + "Unit": { + "type": "string", + "valueString": "hours", + "content": "hours", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.8444, + 5.6883, + 5.2071, + 5.6883, + 5.2071, + 5.803, + 4.8444, + 5.803 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 636, + "length": 5 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 30, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.9669, + 5.6777, + 6.4142, + 5.6777, + 6.4142, + 5.8215, + 5.9669, + 5.8215 + ] + } + ], + "confidence": 0.828, + "spans": [ + { + "offset": 642, + "length": 6 + } + ] + } + }, + "content": "3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.6777, + 7.9116, + 5.6777, + 7.9116, + 5.8312, + 0.592, + 5.8312 + ] + } + ], + "confidence": 0.955, + "spans": [ + { + "offset": 600, + "length": 59 + } + ] + }, + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 30, + "content": "$30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.1182, + 7.4642, + 6.1182 + ] + } + ], + "confidence": 0.916, + "spans": [ + { + "offset": 699, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-05", + "content": "3/5/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.9787, + 1.2088, + 5.9787, + 1.2088, + 6.121, + 0.592, + 6.121 + ] + } + ], + "confidence": 0.902, + "spans": [ + { + "offset": 660, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Document Fee", + "content": "Document Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.345, + 5.993, + 3.3096, + 5.993, + 3.3096, + 6.0997, + 2.345, + 6.0997 + ] + } + ], + "confidence": 0.901, + "spans": [ + { + "offset": 674, + "length": 12 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "B456", + "content": "B456", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6214, + 5.9915, + 1.9419, + 5.9915, + 1.9419, + 6.0997, + 1.6214, + 6.0997 + ] + } + ], + "confidence": 0.886, + "spans": [ + { + "offset": 669, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 3, + "content": "3", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5967, + 5.9915, + 4.6627, + 5.9915, + 4.6627, + 6.0997, + 4.5967, + 6.0997 + ] + } + ], + "confidence": 0.898, + "spans": [ + { + "offset": 687, + "length": 1 + } + ] + }, + "Tax": { + "type": "number", + "content": "5%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.7508, + 5.9898, + 6.9393, + 5.9898, + 6.9393, + 6.1012, + 6.7508, + 6.1012 + ] + } + ], + "confidence": 0.772, + "spans": [ + { + "offset": 696, + "length": 2 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 5.9669, + 5.9743, + 6.4142, + 5.9743, + 6.4142, + 6.1182, + 5.9669, + 6.1182 + ] + } + ], + "confidence": 0.831, + "spans": [ + { + "offset": 689, + "length": 6 + } + ] + } + }, + "content": "3/5/2021 B456 Document Fee 3 $10.00 5% $30.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 5.9743, + 7.9116, + 5.9743, + 7.9116, + 6.121, + 0.592, + 6.121 + ] + } + ], + "confidence": 0.941, + "spans": [ + { + "offset": 660, + "length": 45 + } + ] + }, + { + "type": "object", + "valueObject": { + "Amount": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4642, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4184, + 7.4642, + 6.4184 + ] + } + ], + "confidence": 0.959, + "spans": [ + { + "offset": 752, + "length": 6 + } + ] + }, + "Date": { + "type": "date", + "valueDate": "2021-03-06", + "content": "3/6/2021", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 6.2789, + 1.2088, + 6.2789, + 1.2088, + 6.4213, + 0.592, + 6.4213 + ] + } + ], + "confidence": 0.903, + "spans": [ + { + "offset": 706, + "length": 8 + } + ] + }, + "Description": { + "type": "string", + "valueString": "Printing Fee", + "content": "Printing Fee", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 2.345, + 6.2906, + 3.1351, + 6.2906, + 3.1351, + 6.4281, + 2.345, + 6.4281 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 720, + "length": 12 + } + ] + }, + "ProductCode": { + "type": "string", + "valueString": "C789", + "content": "C789", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.6152, + 6.2918, + 1.94, + 6.2918, + 1.94, + 6.3999, + 1.6152, + 6.3999 + ] + } + ], + "confidence": 0.898, + "spans": [ + { + "offset": 715, + "length": 4 + } + ] + }, + "Quantity": { + "type": "number", + "valueNumber": 10, + "content": "10", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.5158, + 6.2918, + 4.6637, + 6.2918, + 4.6637, + 6.3999, + 4.5158, + 6.3999 + ] + } + ], + "confidence": 0.903, + "spans": [ + { + "offset": 733, + "length": 2 + } + ] + }, + "Tax": { + "type": "number", + "content": "20%", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.712, + 6.2901, + 6.9826, + 6.2901, + 6.9826, + 6.4014, + 6.712, + 6.4014 + ] + } + ], + "confidence": 0.791, + "spans": [ + { + "offset": 748, + "length": 3 + } + ] + }, + "Unit": { + "type": "string", + "valueString": "pages", + "content": "pages", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 4.8444, + 6.3196, + 5.2199, + 6.3196, + 5.2199, + 6.4281, + 4.8444, + 6.4281 + ] + } + ], + "confidence": 0.899, + "spans": [ + { + "offset": 736, + "length": 5 + } + ] + }, + "UnitPrice": { + "type": "number", + "valueNumber": 1, + "content": "$1.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.0502, + 6.2746, + 6.4142, + 6.2746, + 6.4142, + 6.4184, + 6.0502, + 6.4184 + ] + } + ], + "confidence": 0.829, + "spans": [ + { + "offset": 742, + "length": 5 + } + ] + } + }, + "content": "3/6/2021 C789 Printing Fee 10 pages $1.00 20% $10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.592, + 6.2746, + 7.9116, + 6.2746, + 7.9116, + 6.4281, + 0.592, + 6.4281 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 706, + "length": 52 + } + ] + } + ] + }, + "Locale": { + "type": "string", + "valueString": "en-US", + "confidence": 1 + }, + "PreviousUnpaidBalance": { + "type": "number", + "valueNumber": 500, + "content": "$500.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 7.7617, + 7.9181, + 7.7617, + 7.9181, + 7.9055, + 7.3842, + 7.9055 + ] + } + ], + "confidence": 0.962, + "spans": [ + { + "offset": 831, + "length": 7 + } + ] + }, + "PurchaseOrder": { + "type": "string", + "valueString": "PO-3333", + "content": "PO-3333", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 1.9114, + 4.9282, + 2.4718, + 4.9282, + 2.4718, + 5.0363, + 1.9114, + 5.0363 + ] + } + ], + "confidence": 0.967, + "spans": [ + { + "offset": 541, + "length": 7 + } + ] + }, + "RemittanceAddress": { + "type": "string", + "valueString": "123 Remit St New York, NY, 10001", + "content": "123 Remit St New York, NY, 10001", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 9.5717, + 1.9882, + 9.5717, + 1.9882, + 9.9098, + 0.5943, + 9.9098 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 913, + "length": 32 + } + ] + }, + "RemittanceAddressRecipient": { + "type": "string", + "valueString": "Contoso Billing", + "content": "Contoso Billing", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5882, + 9.3631, + 1.5828, + 9.3631, + 1.5828, + 9.5059, + 0.5882, + 9.5059 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 897, + "length": 15 + } + ] + }, + "ServiceAddress": { + "type": "string", + "valueString": "123 Service St, Redmond WA, 98052", + "content": "123 Service St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2197, + 3.9734, + 7.6337, + 3.9734, + 7.6337, + 4.3082, + 6.2197, + 4.3082 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 402, + "length": 15 + }, + { + "offset": 454, + "length": 17 + } + ] + }, + "ServiceAddressRecipient": { + "type": "string", + "valueString": "Microsoft Services", + "content": "Microsoft Services", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.2197, + 3.7641, + 7.4427, + 3.7641, + 7.4427, + 3.8794, + 6.2197, + 3.8794 + ] + } + ], + "confidence": 0.951, + "spans": [ + { + "offset": 357, + "length": 18 + } + ] + }, + "ServiceEndDate": { + "type": "date", + "valueDate": "2019-11-14", + "content": "11/14/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.2528, + 2.2306, + 7.9952, + 2.2306, + 7.9952, + 2.3615, + 7.2528, + 2.3615 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 204, + "length": 10 + } + ] + }, + "ServiceStartDate": { + "type": "date", + "valueDate": "2019-10-14", + "content": "10/14/2019", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 6.3357, + 2.2306, + 7.0749, + 2.2306, + 7.0749, + 2.3615, + 6.3357, + 2.3615 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 191, + "length": 10 + } + ] + }, + "ShippingAddress": { + "type": "string", + "valueString": "123 Ship St, Redmond WA, 98052", + "content": "123 Ship St, Redmond WA, 98052", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3454, + 3.9681, + 4.7594, + 3.9681, + 4.7594, + 4.3082, + 3.3454, + 4.3082 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 389, + "length": 12 + }, + { + "offset": 436, + "length": 17 + } + ] + }, + "ShippingAddressRecipient": { + "type": "string", + "valueString": "Microsoft Delivery", + "content": "Microsoft Delivery", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 3.3454, + 3.7641, + 4.5762, + 3.7641, + 4.5762, + 3.9076, + 3.3454, + 3.9076 + ] + } + ], + "confidence": 0.955, + "spans": [ + { + "offset": 338, + "length": 18 + } + ] + }, + "SubTotal": { + "type": "number", + "valueNumber": 100, + "content": "$100.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.3842, + 6.8679, + 7.9181, + 6.8679, + 7.9181, + 7.0118, + 7.3842, + 7.0118 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 768, + "length": 7 + } + ] + }, + "TotalTax": { + "type": "number", + "valueNumber": 10, + "content": "$10.00", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 7.4709, + 7.165, + 7.9182, + 7.165, + 7.9182, + 7.3089, + 7.4709, + 7.3089 + ] + } + ], + "confidence": 0.973, + "spans": [ + { + "offset": 786, + "length": 6 + } + ] + }, + "VendorAddress": { + "type": "string", + "valueString": "123 456th St New York, NY, 10001", + "content": "123 456th St New York, NY, 10001", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5943, + 1.6092, + 1.9894, + 1.6092, + 1.9894, + 1.9675, + 0.5943, + 1.9675 + ] + } + ], + "confidence": 0.946, + "spans": [ + { + "offset": 59, + "length": 12 + }, + { + "offset": 97, + "length": 19 + } + ] + }, + "VendorAddressRecipient": { + "type": "string", + "valueString": "Contoso Headquarters", + "content": "Contoso Headquarters", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5882, + 1.4239, + 2.0978, + 1.4239, + 2.0978, + 1.5664, + 0.5882, + 1.5664 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 21, + "length": 20 + } + ] + }, + "VendorName": { + "type": "string", + "valueString": "CONTOSO LTD.", + "content": "CONTOSO LTD.", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0.5911, + 0.6857, + 2.3181, + 0.6857, + 2.3181, + 0.8664, + 0.5911, + 0.8664 + ] + } + ], + "confidence": 0.956, + "spans": [ + { + "offset": 0, + "length": 12 + } + ] + } + }, + "confidence": 1, + "spans": [ + { + "offset": 0, + "length": 958 + } + ] + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetClassifyDocumentResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetClassifyDocumentResult.json index 1e752ec04d25..01fbc604d18f 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetClassifyDocumentResult.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetClassifyDocumentResult.json @@ -1,101 +1,101 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "classifierId": "myClassifier", - "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" - }, - "responses": { - "200": { - "body": { - "status": "succeeded", - "createdDateTime": "2021-09-24T13:00:46Z", - "lastUpdatedDateTime": "2021-09-24T13:00:49Z", - "analyzeResult": { - "apiVersion": "2023-07-31", - "modelId": "myClassifier", - "stringIndexType": "textElements", - "content": "", - "pages": [ - { - "pageNumber": 1, - "width": 8.5, - "height": 11, - "unit": "inch", - "spans": [] - }, - { - "pageNumber": 2, - "width": 8.5, - "height": 11, - "unit": "inch", - "spans": [] - }, - { - "pageNumber": 3, - "width": 8.5, - "height": 11, - "unit": "inch", - "spans": [] - } - ], - "documents": [ - { - "docType": "formA", - "boundingRegions": [ - { - "pageNumber": 1, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - }, - { - "pageNumber": 2, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "confidence": 0.97, - "spans": [] - }, - { - "docType": "formB", - "boundingRegions": [ - { - "pageNumber": 3, - "polygon": [ - 0, - 0, - 8.5, - 0, - 8.5, - 11, - 0, - 11 - ] - } - ], - "confidence": 0.97, - "spans": [] - } - ] - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "classifierId": "myClassifier", + "resultId": "3b31320d-8bab-4f88-b19c-2322a7f11034" + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2021-09-24T13:00:46Z", + "lastUpdatedDateTime": "2021-09-24T13:00:49Z", + "analyzeResult": { + "apiVersion": "2023-07-31", + "modelId": "myClassifier", + "stringIndexType": "textElements", + "content": "", + "pages": [ + { + "pageNumber": 1, + "width": 8.5, + "height": 11, + "unit": "inch", + "spans": [] + }, + { + "pageNumber": 2, + "width": 8.5, + "height": 11, + "unit": "inch", + "spans": [] + }, + { + "pageNumber": 3, + "width": 8.5, + "height": 11, + "unit": "inch", + "spans": [] + } + ], + "documents": [ + { + "docType": "formA", + "boundingRegions": [ + { + "pageNumber": 1, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + }, + { + "pageNumber": 2, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "confidence": 0.97, + "spans": [] + }, + { + "docType": "formB", + "boundingRegions": [ + { + "pageNumber": 3, + "polygon": [ + 0, + 0, + 8.5, + 0, + 8.5, + 11, + 0, + 11 + ] + } + ], + "confidence": 0.97, + "spans": [] + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifier.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifier.json index a0665b490477..376bf78ba417 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifier.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifier.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "classifierId": "myClassifier" - }, - "responses": { - "200": { - "body": { - "classifierId": "myClassifier", - "description": "Classifier description", - "createdDateTime": "2022-07-30T00:00:00Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-07-31", - "docTypes": { - "formA": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formADocs/" - } - }, - "formB": { - "azureBlobFileListSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "fileList": "formB.jsonl" - } - } - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "classifierId": "myClassifier" + }, + "responses": { + "200": { + "body": { + "classifierId": "myClassifier", + "description": "Classifier description", + "createdDateTime": "2022-07-30T00:00:00Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-07-31", + "docTypes": { + "formA": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formADocs/" + } + }, + "formB": { + "azureBlobFileListSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "fileList": "formB.jsonl" + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifiers.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifiers.json index 85896f229e3d..d9e47160db5e 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifiers.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentClassifiers.json @@ -1,57 +1,57 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "classifierId": "classifier1", - "description": "Classifier1 description", - "createdDateTime": "2022-07-30T00:00:00Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-07-31", - "docTypes": { - "formA": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formADocs/" - } - }, - "formB": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formBDocs/" - } - } - } - }, - { - "classifierId": "classifier2", - "description": "Classifier2 description", - "createdDateTime": "2022-07-30T00:00:00Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-07-31", - "docTypes": { - "formB": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formBDocs/" - } - }, - "formC": { - "azureBlobSource": { - "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", - "prefix": "formCDocs/" - } - } - } - } - ], - "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers?nextLink=nextLinkData" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "classifierId": "classifier1", + "description": "Classifier1 description", + "createdDateTime": "2022-07-30T00:00:00Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-07-31", + "docTypes": { + "formA": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formADocs/" + } + }, + "formB": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formBDocs/" + } + } + } + }, + { + "classifierId": "classifier2", + "description": "Classifier2 description", + "createdDateTime": "2022-07-30T00:00:00Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-07-31", + "docTypes": { + "formB": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formBDocs/" + } + }, + "formC": { + "azureBlobSource": { + "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", + "prefix": "formCDocs/" + } + } + } + } + ], + "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers?nextLink=nextLinkData" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Custom.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Custom.json index fbb5a794602d..9562be774a20 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Custom.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Custom.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "myCustomModel" - }, - "responses": { - "200": { - "body": { - "modelId": "myCustomModel", - "description": "Custom model description", - "createdDateTime": "2021-09-24T12:54:35Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "apiVersion": "2023-07-31", - "docTypes": { - "myForm": { - "fieldSchema": { - "Name": { - "type": "string" - }, - "Date": { - "type": "date" - }, - "Amount": { - "type": "number" - } - }, - "buildMode": "template", - "fieldConfidence": { - "Name": 0.9, - "Date": 0.95, - "Amount": 0.93 - } - } - }, - "tags": { - "createdBy": "myUserId" - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "myCustomModel" + }, + "responses": { + "200": { + "body": { + "modelId": "myCustomModel", + "description": "Custom model description", + "createdDateTime": "2021-09-24T12:54:35Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "apiVersion": "2023-07-31", + "docTypes": { + "myForm": { + "fieldSchema": { + "Name": { + "type": "string" + }, + "Date": { + "type": "date" + }, + "Amount": { + "type": "number" + } + }, + "buildMode": "template", + "fieldConfidence": { + "Name": 0.9, + "Date": 0.95, + "Amount": 0.93 + } + } + }, + "tags": { + "createdBy": "myUserId" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Prebuilt.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Prebuilt.json index 4b88363b863d..77d9731ae97d 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Prebuilt.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModel_Prebuilt.json @@ -1,134 +1,134 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "modelId": "prebuilt-invoice" - }, - "responses": { - "200": { - "body": { - "modelId": "prebuilt-invoice", - "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.", - "createdDateTime": "2021-07-30T00:00:00Z", - "apiVersion": "2023-07-31", - "docTypes": { - "prebuilt:invoice": { - "fieldSchema": { - "CustomerName": { - "type": "string" - }, - "CustomerId": { - "type": "string" - }, - "PurchaseOrder": { - "type": "string" - }, - "InvoiceId": { - "type": "string" - }, - "InvoiceDate": { - "type": "date" - }, - "DueDate": { - "type": "date" - }, - "VendorName": { - "type": "string" - }, - "VendorAddress": { - "type": "string" - }, - "VendorAddressRecipient": { - "type": "string" - }, - "CustomerAddress": { - "type": "string" - }, - "CustomerAddressRecipient": { - "type": "string" - }, - "BillingAddress": { - "type": "string" - }, - "BillingAddressRecipient": { - "type": "string" - }, - "ShippingAddress": { - "type": "string" - }, - "ShippingAddressRecipient": { - "type": "string" - }, - "SubTotal": { - "type": "number" - }, - "TotalTax": { - "type": "number" - }, - "InvoiceTotal": { - "type": "number" - }, - "AmountDue": { - "type": "number" - }, - "PreviousUnpaidBalance": { - "type": "number" - }, - "RemittanceAddress": { - "type": "string" - }, - "RemittanceAddressRecipient": { - "type": "string" - }, - "ServiceAddress": { - "type": "string" - }, - "ServiceAddressRecipient": { - "type": "string" - }, - "ServiceStartDate": { - "type": "date" - }, - "ServiceEndDate": { - "type": "date" - }, - "Items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Amount": { - "type": "number" - }, - "Date": { - "type": "date" - }, - "Description": { - "type": "string" - }, - "Quantity": { - "type": "number" - }, - "ProductCode": { - "type": "string" - }, - "Tax": { - "type": "number" - }, - "Unit": { - "type": "string" - }, - "UnitPrice": { - "type": "number" - } - } - } - } - } - } - }, - "tags": {} - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "modelId": "prebuilt-invoice" + }, + "responses": { + "200": { + "body": { + "modelId": "prebuilt-invoice", + "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.", + "createdDateTime": "2021-07-30T00:00:00Z", + "apiVersion": "2023-07-31", + "docTypes": { + "prebuilt:invoice": { + "fieldSchema": { + "CustomerName": { + "type": "string" + }, + "CustomerId": { + "type": "string" + }, + "PurchaseOrder": { + "type": "string" + }, + "InvoiceId": { + "type": "string" + }, + "InvoiceDate": { + "type": "date" + }, + "DueDate": { + "type": "date" + }, + "VendorName": { + "type": "string" + }, + "VendorAddress": { + "type": "string" + }, + "VendorAddressRecipient": { + "type": "string" + }, + "CustomerAddress": { + "type": "string" + }, + "CustomerAddressRecipient": { + "type": "string" + }, + "BillingAddress": { + "type": "string" + }, + "BillingAddressRecipient": { + "type": "string" + }, + "ShippingAddress": { + "type": "string" + }, + "ShippingAddressRecipient": { + "type": "string" + }, + "SubTotal": { + "type": "number" + }, + "TotalTax": { + "type": "number" + }, + "InvoiceTotal": { + "type": "number" + }, + "AmountDue": { + "type": "number" + }, + "PreviousUnpaidBalance": { + "type": "number" + }, + "RemittanceAddress": { + "type": "string" + }, + "RemittanceAddressRecipient": { + "type": "string" + }, + "ServiceAddress": { + "type": "string" + }, + "ServiceAddressRecipient": { + "type": "string" + }, + "ServiceStartDate": { + "type": "date" + }, + "ServiceEndDate": { + "type": "date" + }, + "Items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Amount": { + "type": "number" + }, + "Date": { + "type": "date" + }, + "Description": { + "type": "string" + }, + "Quantity": { + "type": "number" + }, + "ProductCode": { + "type": "string" + }, + "Tax": { + "type": "number" + }, + "Unit": { + "type": "string" + }, + "UnitPrice": { + "type": "number" + } + } + } + } + } + } + }, + "tags": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModels.json index eed9a0cf7d1d..00c4146e8431 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModels.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetDocumentModels.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "modelId": "prebuilt-layout", - "createdDateTime": "2021-07-30T00:00:00Z", - "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.", - "apiVersion": "2023-07-31" - }, - { - "modelId": "myCustomModel", - "createdDateTime": "2021-09-24T12:54:35Z", - "expirationDateTime": "2023-01-01T00:00:00Z", - "description": "Custom model description", - "apiVersion": "2023-07-31" - } - ], - "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels?nextLink=nextLinkData" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "modelId": "prebuilt-layout", + "createdDateTime": "2021-07-30T00:00:00Z", + "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.", + "apiVersion": "2023-07-31" + }, + { + "modelId": "myCustomModel", + "createdDateTime": "2021-09-24T12:54:35Z", + "expirationDateTime": "2023-01-01T00:00:00Z", + "description": "Custom model description", + "apiVersion": "2023-07-31" + } + ], + "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels?nextLink=nextLinkData" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperation.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperation.json index 3cd5b9e1309f..7f51fd4e741e 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperation.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperation.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31", - "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4" - }, - "responses": { - "200": { - "body": { - "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4", - "status": "succeeded", - "percentCompleted": 100, - "createdDateTime": "2021-09-23T09:12:57Z", - "lastUpdatedDateTime": "2021-09-23T09:13:01Z", - "kind": "documentModelBuild", - "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", - "result": { - "modelId": "myCustomModel", - "description": "Custom model description", - "createdDateTime": "2021-09-23T09:13:01Z", - "apiVersion": "2023-07-31" - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31", + "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4" + }, + "responses": { + "200": { + "body": { + "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4", + "status": "succeeded", + "percentCompleted": 100, + "createdDateTime": "2021-09-23T09:12:57Z", + "lastUpdatedDateTime": "2021-09-23T09:13:01Z", + "kind": "documentModelBuild", + "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", + "result": { + "modelId": "myCustomModel", + "description": "Custom model description", + "createdDateTime": "2021-09-23T09:13:01Z", + "apiVersion": "2023-07-31" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperations.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperations.json index a10560556e80..49afff9eebea 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperations.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperations.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4", - "status": "running", - "percentCompleted": 0, - "createdDateTime": "2021-09-23T09:12:57Z", - "lastUpdatedDateTime": "2021-09-23T09:12:58Z", - "kind": "documentModelBuild", - "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", - "apiVersion": "2023-07-31" - } - ], - "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData" - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4", + "status": "running", + "percentCompleted": 0, + "createdDateTime": "2021-09-23T09:12:57Z", + "lastUpdatedDateTime": "2021-09-23T09:12:58Z", + "kind": "documentModelBuild", + "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel", + "apiVersion": "2023-07-31" + } + ], + "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetResourceDetails.json b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetResourceDetails.json index 6717612ed698..1deefed1d0ff 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetResourceDetails.json +++ b/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetResourceDetails.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "endpoint": "https://myendpoint.cognitiveservices.azure.com", - "api-version": "2023-07-31" - }, - "responses": { - "200": { - "body": { - "customDocumentModels": { - "count": 2, - "limit": 13 - }, - "customNeuralDocumentModelBuilds": { - "used": 1, - "quota": 10, - "quotaResetDateTime": "2023-03-01T00:00:00Z" - } - } - } - } -} +{ + "parameters": { + "endpoint": "https://myendpoint.cognitiveservices.azure.com", + "api-version": "2023-07-31" + }, + "responses": { + "200": { + "body": { + "customDocumentModels": { + "count": 2, + "limit": 13 + }, + "customNeuralDocumentModelBuilds": { + "used": 1, + "quota": 10, + "quotaResetDateTime": "2023-03-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json b/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json index 95b328914fd6..f843cc3e4725 100644 --- a/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json +++ b/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json @@ -129,7 +129,8 @@ "Creates an Onco Phenotype job with the given request body.": { "$ref": "./examples/SuccessfulOncoPhenotypeRequest.json" } - } + }, + "x-ms-long-running-operation": true } }, "/oncophenotype/jobs/{jobId}": { @@ -254,7 +255,8 @@ "Creates a Trial Matcher job with the given request body.": { "$ref": "./examples/SuccessfulTrialMatcherRequest.json" } - } + }, + "x-ms-long-running-operation": true } }, "/trialmatcher/jobs/{jobId}": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json new file mode 100644 index 000000000000..5dd4289a1bc3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json @@ -0,0 +1,911 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2023-04-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}": { + "put": { + "tags": [ + "Disks" + ], + "operationId": "Disks_CreateOrUpdate", + "description": "Creates or updates a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Disk" + }, + "description": "Disk object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Create an empty managed disk.": { + "$ref": "./examples/diskExamples/Disk_Create_Empty.json" + }, + "Create a managed disk from a platform image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAPlatformImage.json" + }, + "Create a managed disk from an existing managed disk in the same or different subscription.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json" + }, + "Create a managed disk by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json" + }, + "Create a managed disk by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json" + }, + "Create a managed disk by copying a snapshot.": { + "$ref": "./examples/diskExamples/Disk_Create_ByCopyingASnapshot.json" + }, + "Create a managed upload disk.": { + "$ref": "./examples/diskExamples/Disk_Create_UploadDisk.json" + }, + "Create a managed disk and associate with disk access resource.": { + "$ref": "./examples/diskExamples/Disk_Create_WithDiskAccess.json" + }, + "Create a managed disk with dataAccessAuthMode": { + "$ref": "./examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json" + }, + "Create a managed disk and associate with disk encryption set.": { + "$ref": "./examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json" + }, + "Create an ultra managed disk with logicalSectorSize 512E": { + "$ref": "./examples/diskExamples/Disk_Create_WithLogicalSectorSize.json" + }, + "Create an empty managed disk in extended location.": { + "$ref": "./examples/diskExamples/Disk_Create_InExtendedLocation.json" + }, + "Create a managed disk with ssd zrs account type.": { + "$ref": "./examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json" + }, + "Create a managed disk with premium v2 account type.": { + "$ref": "./examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json" + }, + "Create a managed disk with security profile": { + "$ref": "./examples/diskExamples/Disk_Create_WithSecurityProfile.json" + }, + "Create a managed disk from ImportSecure create option": { + "$ref": "./examples/diskExamples/Disk_Create_FromImportSecure.json" + }, + "Create a managed disk from UploadPreparedSecure create option": { + "$ref": "./examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json" + }, + "Create a confidential VM supported disk encrypted with customer managed key": { + "$ref": "./examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json" + }, + "Create a managed disk from an Azure Compute Gallery image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json" + }, + "Create a managed disk from an Azure Compute Gallery direct shared image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json" + }, + "Create a managed disk from an Azure Compute Gallery community image.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json" + }, + "Create a managed disk with optimizedForFrequentAttach.": { + "$ref": "./examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json" + }, + "Create a managed disk with performancePlus.": { + "$ref": "./examples/diskExamples/Disk_Create_PerformancePlus.json" + }, + "Create a managed disk with ultra account type with readOnly property set.": { + "$ref": "./examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json" + }, + "Create a managed disk from elastic san volume snapshot.": { + "$ref": "./examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Update", + "description": "Updates (patches) a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskUpdate" + }, + "description": "Disk object supplied in the body of the Patch disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update managed disk to remove disk access resource association.": { + "$ref": "./examples/diskExamples/Disk_Update_RemoveDiskAccess.json" + }, + "Update a managed disk to add purchase plan.": { + "$ref": "./examples/diskExamples/Disk_Update_AddPurchasePlan.json" + }, + "Update a managed disk to disable bursting.": { + "$ref": "./examples/diskExamples/Disk_Update_DisableBursting.json" + }, + "Create or update a bursting enabled managed disk.": { + "$ref": "./examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json" + }, + "Update a managed disk to add supportsHibernation.": { + "$ref": "./examples/diskExamples/Disk_Update_AddSupportsHibernation.json" + }, + "Update a managed disk to add accelerated networking.": { + "$ref": "./examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json" + }, + "Update a managed disk to change tier.": { + "$ref": "./examples/diskExamples/Disk_Update_ChangeTier.json" + }, + "Update a managed disk to add architecture.": { + "$ref": "./examples/diskExamples//Disk_Update_ToAddArchitecture.json" + }, + "Update a managed disk to disable optimizedForFrequentAttach.": { + "$ref": "./examples/diskExamples//Disk_Update_DisableOptimizedForFrequentAttach.json" + }, + "Update a managed disk with diskControllerTypes.": { + "$ref": "./examples/diskExamples//Disk_Update_AddDiskControllerTypes.json" + } + } + }, + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Get", + "description": "Gets information about a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Get information about a managed disk.": { + "$ref": "./examples/diskExamples/Disk_Get.json" + } + } + }, + "delete": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Delete", + "description": "Deletes a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk is deleted, this is an expected error code." + } + }, + "x-ms-examples": { + "Delete a managed disk.": { + "$ref": "./examples/diskExamples/Disk_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_ListByResourceGroup", + "description": "Lists all the disks under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a resource group.": { + "$ref": "./examples/diskExamples/Disk_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_List", + "description": "Lists all the disks under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a subscription.": { + "$ref": "./examples/diskExamples/Disk_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_GrantAccess", + "description": "Grants access to a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "./diskRPCommon.json#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./diskRPCommon.json#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Get a sas on a managed disk.": { + "$ref": "./examples/diskExamples/Disk_BeginGetAccess.json" + }, + "Get sas on managed disk and VM guest state": { + "$ref": "./examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/endGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_RevokeAccess", + "description": "Revokes access to a disk.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Revoke access to a managed disk.": { + "$ref": "./examples/diskExamples/Disk_EndGetAccess.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Disk": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + }, + "managedByExtended": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." + }, + "sku": { + "$ref": "#/definitions/DiskSku" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Logical zone list for Disk." + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location where the disk will be created. Extended location cannot be changed." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Disk resource." + }, + "DiskUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/DiskSku" + } + }, + "description": "Disk update resource." + }, + "DiskList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "description": "A list of disks." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks." + } + }, + "required": [ + "value" + ], + "description": "The List Disks operation response." + }, + "DiskSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "DiskStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "UltraSSD_LRS", + "description": "Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads." + }, + { + "value": "Premium_ZRS", + "description": "Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures." + }, + { + "value": "StandardSSD_ZRS", + "description": "Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures." + }, + { + "value": "PremiumV2_LRS", + "description": "Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput." + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS." + }, + "DiskProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}" + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the OS disk was created." + }, + "creationData": { + "$ref": "./diskRPCommon.json#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskIOPSReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskState": { + "$ref": "./diskRPCommon.json#/definitions/DiskState", + "description": "The state of the disk." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "maxShares": { + "type": "integer", + "format": "int32", + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "shareInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ShareInfoElement" + }, + "x-ms-identifiers": [ + "vmUri" + ], + "description": "Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "burstingEnabledTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Latest time when bursting was last enabled on a disk." + }, + "tier": { + "type": "string", + "description": "Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks." + }, + "burstingEnabled": { + "type": "boolean", + "description": "Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks." + }, + "propertyUpdatesInProgress": { + "readOnly": true, + "$ref": "#/definitions/PropertyUpdatesInProgress", + "description": "Properties of the disk for which update is pending." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a disk supports hibernation." + }, + "securityProfile": { + "$ref": "./diskRPCommon.json#/definitions/DiskSecurityProfile", + "description": "Contains the security related information for the resource." + }, + "completionPercent": { + "type": "number", + "description": "Percentage complete for the background copy when a resource is created via the CopyStart operation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + }, + "optimizedForFrequentAttach": { + "type": "boolean", + "description": "Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine." + }, + "LastOwnershipUpdateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskIOPSReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "maxShares": { + "type": "integer", + "format": "int32", + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "tier": { + "type": "string", + "description": "Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks." + }, + "burstingEnabled": { + "type": "boolean", + "description": "Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks." + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information to be added on the OS disk" + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities to be added on the OS disk." + }, + "propertyUpdatesInProgress": { + "readOnly": true, + "$ref": "#/definitions/PropertyUpdatesInProgress", + "description": "Properties of the disk for which update is pending." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a disk supports hibernation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + }, + "optimizedForFrequentAttach": { + "type": "boolean", + "description": "Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine." + } + }, + "description": "Disk resource update properties." + }, + "ShareInfoElement": { + "properties": { + "vmUri": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + } + } + }, + "PropertyUpdatesInProgress": { + "properties": { + "targetTier": { + "type": "string", + "description": "The target performance tier of the disk if a tier change operation is in progress." + } + }, + "description": "Properties of the disk for which update is pending." + } + }, + "parameters": { + "DiskNameParameter": { + "name": "diskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json new file mode 100644 index 000000000000..1236302c33ae --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json @@ -0,0 +1,824 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2023-04-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}": { + "put": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_CreateOrUpdate", + "description": "Creates or updates a disk access resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskAccess", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskAccess" + }, + "description": "disk access object supplied in the body of the Put disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Create.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Update", + "description": "Updates (patches) a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskAccess", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskAccessUpdate" + }, + "description": "disk access object supplied in the body of the Patch disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Get", + "description": "Gets information about a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Get.json" + }, + "Get information about a disk access resource with private endpoints.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json" + } + } + }, + "delete": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Delete", + "description": "Deletes a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk access resource is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_ListByResourceGroup", + "description": "Lists all the disk access resources under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccessList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk access resources in a resource group.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_List", + "description": "Lists all the disk access resources under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccessList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk access resources in a subscription.": { + "$ref": "./examples/diskAccessExamples/DiskAccess_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_GetPrivateLinkResources", + "description": "Gets the private link resources possible under disk access resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + }, + "x-ms-examples": { + "List all possible private link resources under disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_UpdateAPrivateEndpointConnection", + "description": "Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "private endpoint connection object supplied in the body of the Put private endpoint connection operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Approve a Private Endpoint Connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_GetAPrivateEndpointConnection", + "description": "Gets information about a private endpoint connection under a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a private endpoint connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json" + } + } + }, + "delete": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_DeleteAPrivateEndpointConnection", + "description": "Deletes a private endpoint connection under a disk access resource.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the private endpoint connection is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a private endpoint connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_ListPrivateEndpointConnections", + "description": "List information about private endpoint connections under a disk access resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a private endpoint connection under a disk access resource.": { + "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DiskAccessProperties": { + "properties": { + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk access resource provisioning state." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk access was created." + } + } + }, + "DiskAccess": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskAccessProperties" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location where the disk access will be created. Extended location cannot be changed." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "disk access resource." + }, + "DiskAccessList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskAccess" + }, + "description": "A list of disk access resources." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources." + } + }, + "required": [ + "value" + ], + "description": "The List disk access operation response." + }, + "DiskAccessUpdate": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "Used for updating a disk access resource." + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "id": { + "readOnly": true, + "type": "string", + "description": "private link resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "private link resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "private link resource type" + } + }, + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point.", + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between DiskAccess and Virtual Network." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection type" + } + }, + "description": "The Private Endpoint Connection resource.", + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." + } + }, + "description": "A list of private link resources" + } + }, + "parameters": { + "DiskAccessNameParameter": { + "name": "diskAccessName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json new file mode 100644 index 000000000000..cc6ee6dd3fb3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json @@ -0,0 +1,604 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2023-04-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}": { + "put": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_CreateOrUpdate", + "description": "Creates or updates a disk encryption set", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "disk encryption set object supplied in the body of the Put disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json" + }, + "Create a disk encryption set with key vault from a different subscription.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json" + }, + "Create a disk encryption set with key vault from a different tenant.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Update", + "description": "Updates (patches) a disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSetUpdate" + }, + "description": "disk encryption set object supplied in the body of the Patch disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json" + }, + "Update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Succeeded": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json" + }, + "Update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Updating": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Get", + "description": "Gets information about a disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json" + }, + "Get information about a disk encryption set when auto-key rotation failed.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json" + } + } + }, + "delete": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Delete", + "description": "Deletes a disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk encryption set is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_ListByResourceGroup", + "description": "Lists all the disk encryption sets under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a resource group.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_List", + "description": "Lists all the disk encryption sets under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a subscription.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_ListAssociatedResources", + "description": "Lists all resources that are encrypted with this disk encryption set.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceUriList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all resources that are encrypted with this disk encryption set.": { + "$ref": "./examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "EncryptionSetProperties": { + "properties": { + "encryptionType": { + "$ref": "#/definitions/DiskEncryptionSetType" + }, + "activeKey": { + "$ref": "#/definitions/KeyForDiskEncryptionSet", + "description": "The key vault key which is currently used by this disk encryption set." + }, + "previousKeys": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/KeyForDiskEncryptionSet" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk encryption set provisioning state." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Set this flag to true to enable auto-updating of this disk encryption set to the latest key version." + }, + "lastKeyRotationTimestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the active key of this disk encryption set was updated." + }, + "autoKeyRotationError": { + "readOnly": true, + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "description": "The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed." + }, + "federatedClientId": { + "type": "string", + "description": "Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property." + } + } + }, + "EncryptionSetIdentity": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "DiskEncryptionSetIdentityType", + "modelAsString": true + }, + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + }, + "userAssignedIdentities": { + "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "DiskEncryptionSetType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys", + "ConfidentialVmEncryptedWithCustomerKey" + ], + "x-ms-enum": { + "name": "DiskEncryptionSetType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + }, + { + "value": "ConfidentialVmEncryptedWithCustomerKey", + "description": "Confidential VM supported disk and VM guest state would be encrypted with customer managed key." + } + ] + } + }, + "KeyForDiskEncryptionSet": { + "properties": { + "sourceVault": { + "$ref": "./diskRPCommon.json#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription." + }, + "keyUrl": { + "type": "string", + "description": "Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value." + } + }, + "required": [ + "keyUrl" + ], + "description": "Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots" + }, + "DiskEncryptionSet": { + "properties": { + "identity": { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EncryptionSetProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "disk encryption set resource." + }, + "DiskEncryptionSetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskEncryptionSetUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "identity": { + "$ref": "#/definitions/EncryptionSetIdentity" + } + }, + "description": "disk encryption set update resource." + }, + "DiskEncryptionSetUpdateProperties": { + "properties": { + "encryptionType": { + "$ref": "#/definitions/DiskEncryptionSetType" + }, + "activeKey": { + "$ref": "#/definitions/KeyForDiskEncryptionSet" + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Set this flag to true to enable auto-updating of this disk encryption set to the latest key version." + }, + "federatedClientId": { + "type": "string", + "description": "Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property." + } + }, + "description": "disk encryption set resource update properties." + }, + "DiskEncryptionSetList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "A list of disk encryption sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets." + } + }, + "required": [ + "value" + ], + "description": "The List disk encryption set operation response." + }, + "ResourceUriList": { + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of IDs or Owner IDs of resources which are encrypted with the disk encryption set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of encrypted resources. Call ListNext() with this to fetch the next page of encrypted resources." + } + }, + "required": [ + "value" + ], + "description": "The List resources which are encrypted with the disk encryption set." + } + }, + "parameters": { + "DiskEncryptionSetNameParameter": { + "name": "diskEncryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json new file mode 100644 index 000000000000..62f71f29b2b4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json @@ -0,0 +1,632 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2023-04-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "EncryptionSettingsCollection": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + }, + "x-ms-identifiers": [ + "diskEncryptionKey/sourceVault/id" + ], + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndSecretReference", + "description": "Key Vault Secret Url and vault id of the disk encryption key" + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference", + "description": "Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key." + } + }, + "description": "Encryption settings for one disk volume." + }, + "KeyVaultAndSecretReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "KeyVaultAndKeyReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "SourceVault": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "EncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets." + }, + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + } + ] + } + }, + "Encryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "description": "Encryption at rest settings for disk or snapshot" + }, + "NetworkAccessPolicy": { + "type": "string", + "description": "Policy for accessing the disk via network.", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ], + "x-ms-enum": { + "name": "NetworkAccessPolicy", + "modelAsString": true, + "values": [ + { + "value": "AllowAll", + "description": "The disk can be exported or uploaded to from any network." + }, + { + "value": "AllowPrivate", + "description": "The disk can be exported or uploaded to using a DiskAccess resource's private endpoints." + }, + { + "value": "DenyAll", + "description": "The disk cannot be exported." + } + ] + } + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Policy for controlling export on the disk.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate." + }, + { + "value": "Disabled", + "description": "You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate." + } + ] + } + }, + "DiskState": { + "type": "string", + "description": "This enumerates the possible state of the disk.", + "readOnly": true, + "enum": [ + "Unattached", + "Attached", + "Reserved", + "Frozen", + "ActiveSAS", + "ActiveSASFrozen", + "ReadyToUpload", + "ActiveUpload" + ], + "x-ms-enum": { + "name": "DiskState", + "modelAsString": true, + "values": [ + { + "value": "Unattached", + "description": "The disk is not being used and can be attached to a VM." + }, + { + "value": "Attached", + "description": "The disk is currently attached to a running VM." + }, + { + "value": "Reserved", + "description": "The disk is attached to a stopped-deallocated VM." + }, + { + "value": "Frozen", + "description": "The disk is attached to a VM which is in hibernated state." + }, + { + "value": "ActiveSAS", + "description": "The disk currently has an Active SAS Uri associated with it." + }, + { + "value": "ActiveSASFrozen", + "description": "The disk is attached to a VM in hibernated state and has an active SAS URI associated with it." + }, + { + "value": "ReadyToUpload", + "description": "A disk is ready to be created by upload by requesting a write token." + }, + { + "value": "ActiveUpload", + "description": "A disk is created for upload and a write token has been issued for uploading to it." + } + ] + } + }, + "CreationData": { + "properties": { + "createOption": { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload", + "CopyStart", + "ImportSecure", + "UploadPreparedSecure", + "CopyFromSanSnapshot" + ], + "x-ms-enum": { + "name": "DiskCreateOption", + "modelAsString": true, + "values": [ + { + "value": "Empty", + "description": "Create an empty data disk of a size given by diskSizeGB." + }, + { + "value": "Attach", + "description": "Disk will be attached to a VM." + }, + { + "value": "FromImage", + "description": "Create a new disk from a platform image specified by the given imageReference or galleryImageReference." + }, + { + "value": "Import", + "description": "Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId." + }, + { + "value": "Copy", + "description": "Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId." + }, + { + "value": "Restore", + "description": "Create a new disk by copying from a backup recovery point." + }, + { + "value": "Upload", + "description": "Create a new disk by obtaining a write token and using it to directly upload the contents of the disk." + }, + { + "value": "CopyStart", + "description": "Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source." + }, + { + "value": "ImportSecure", + "description": "Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blob for VM guest state specified by securityDataUri in storage account specified by storageAccountId" + }, + { + "value": "UploadPreparedSecure", + "description": "Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in both disk and VM guest state" + }, + { + "value": "CopyFromSanSnapshot", + "description": "Create a new disk by exporting from elastic san volume snapshot" + } + ] + }, + "description": "This enumerates the possible sources of a disk's creation." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "imageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Disk source information for PIR or user images." + }, + "galleryImageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUniqueId": { + "readOnly": true, + "type": "string", + "description": "If this field is set, this is the unique id identifying the source of this resource." + }, + "uploadSizeBytes": { + "type": "integer", + "format": "int64", + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + }, + "logicalSectorSize": { + "type": "integer", + "format": "int32", + "description": "Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default." + }, + "securityDataUri": { + "type": "string", + "description": "If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state." + }, + "performancePlus": { + "type": "boolean", + "description": "Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled." + }, + "elasticSanResourceId": { + "type": "string", + "description": "Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "ImageDiskReference": { + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference." + }, + "sharedGalleryImageId": { + "type": "string", + "description": "A relative uri containing a direct shared Azure Compute Gallery image reference." + }, + "communityGalleryImageId": { + "type": "string", + "description": "A relative uri containing a community Azure Compute Gallery image reference." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "description": "The source image used for creating the disk." + }, + "PurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The Offer Promotion Code." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "CopyCompletionError": { + "type": "object", + "properties": { + "errorCode": { + "type": "string", + "description": "Indicates the error code if the background copy of a resource created via the CopyStart operation fails.", + "enum": [ + "CopySourceNotFound" + ], + "x-ms-enum": { + "name": "CopyCompletionErrorReason", + "modelAsString": true, + "values": [ + { + "value": "CopySourceNotFound", + "description": "Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress." + } + ] + } + }, + "errorMessage": { + "type": "string", + "description": "Indicates the error message if the background copy of a resource created via the CopyStart operation fails." + } + }, + "required": [ + "errorCode", + "errorMessage" + ], + "description": "Indicates the error details if the background copy of a resource created via the CopyStart operation fails." + }, + "SupportedCapabilities": { + "type": "object", + "properties": { + "diskControllerTypes": { + "type": "string", + "description": "The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI." + }, + "acceleratedNetwork": { + "type": "boolean", + "description": "True if the image from which the OS disk is created supports accelerated networking." + }, + "architecture": { + "type": "string", + "description": "CPU architecture supported by an OS disk.", + "enum": [ + "x64", + "Arm64" + ], + "x-ms-enum": { + "name": "Architecture", + "modelAsString": true + } + } + }, + "description": "List of supported capabilities persisted on the disk resource for VM use." + }, + "DiskSecurityType": { + "type": "string", + "description": "Specifies the SecurityType of the VM. Applicable for OS disks only.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey", + "ConfidentialVM_DiskEncryptedWithPlatformKey", + "ConfidentialVM_DiskEncryptedWithCustomerKey" + ], + "x-ms-enum": { + "name": "DiskSecurityTypes", + "modelAsString": true, + "values": [ + { + "value": "TrustedLaunch", + "description": "Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM)" + }, + { + "value": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey", + "description": "Indicates Confidential VM disk with only VM guest state encrypted" + }, + { + "value": "ConfidentialVM_DiskEncryptedWithPlatformKey", + "description": "Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key" + }, + { + "value": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "description": "Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key" + } + ] + } + }, + "DiskSecurityProfile": { + "properties": { + "securityType": { + "$ref": "#/definitions/DiskSecurityType" + }, + "secureVMDiskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key" + } + }, + "description": "Contains the security related information for the resource." + }, + "GrantAccessData": { + "properties": { + "access": { + "type": "string", + "enum": [ + "None", + "Read", + "Write" + ], + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "durationInSeconds": { + "type": "integer", + "format": "int32", + "description": "Time duration in seconds until the SAS access expires." + }, + "getSecureVMGuestStateSAS": { + "type": "boolean", + "description": "Set this flag to true to get additional SAS for VM guest state" + }, + "fileFormat": { + "type": "string", + "description": "Used to specify the file format when making request for SAS on a VHDX file format snapshot", + "enum": [ + "VHD", + "VHDX" + ], + "x-ms-enum": { + "name": "FileFormat", + "modelAsString": true, + "values": [ + { + "value": "VHD", + "description": "A VHD file is a disk image file in the Virtual Hard Disk file format." + }, + { + "value": "VHDX", + "description": "A VHDX file is a disk image file in the Virtual Hard Disk v2 file format." + } + ] + } + } + }, + "required": [ + "access", + "durationInSeconds" + ], + "description": "Data used for requesting a SAS." + }, + "AccessUri": { + "properties": { + "accessSAS": { + "readOnly": true, + "type": "string", + "description": "A SAS uri for accessing a disk." + }, + "securityDataAccessSAS": { + "readOnly": true, + "type": "string", + "description": "A SAS uri for accessing a VM guest state." + } + }, + "description": "A disk access SAS uri." + }, + "DataAccessAuthMode": { + "type": "string", + "description": "Additional authentication requirements when exporting or uploading to a disk or snapshot.", + "enum": [ + "AzureActiveDirectory", + "None" + ], + "x-ms-enum": { + "name": "DataAccessAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AzureActiveDirectory", + "description": "When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth." + }, + { + "value": "None", + "description": "No additional authentication would be performed when accessing export/upload URL." + } + ] + } + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json new file mode 100644 index 000000000000..56dc8d755518 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json @@ -0,0 +1,430 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2023-04-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}": { + "get": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_Get", + "description": "Get disk restorePoint resource", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskRestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an incremental disk restorePoint resource.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_Get.json" + }, + "Get an incremental disk restorePoint when source resource is from a different region": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints": { + "get": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_ListByRestorePoint", + "description": "Lists diskRestorePoints under a vmRestorePoint.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskRestorePointList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an incremental disk restorePoint resource.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/beginGetAccess": { + "post": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_GrantAccess", + "description": "Grants access to a diskRestorePoint.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "./diskRPCommon.json#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./diskRPCommon.json#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Grants access to a diskRestorePoint.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/endGetAccess": { + "post": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_RevokeAccess", + "description": "Revokes access to a diskRestorePoint.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Revokes access to a diskRestorePoint.": { + "$ref": "./examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json" + } + } + } + } + }, + "definitions": { + "DiskRestorePoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskRestorePointProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "description": "Properties of disk restore point" + }, + "DiskRestorePointList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskRestorePoint" + }, + "description": "A list of disk restore points." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk restore points. Call ListNext() with this to fetch the next page of disk restore points." + } + }, + "required": [ + "value" + ], + "description": "The List Disk Restore Points operation response." + }, + "DiskRestorePointProperties": { + "properties": { + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "The timestamp of restorePoint creation", + "readOnly": true + }, + "sourceResourceId": { + "type": "string", + "description": "arm id of source disk or source disk restore point.", + "readOnly": true + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information for the the image from which the OS disk was created." + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the OS disk was created." + }, + "familyId": { + "type": "string", + "description": "id of the backing snapshot's MIS family", + "readOnly": true + }, + "sourceUniqueId": { + "type": "string", + "description": "unique incarnation id of the source disk", + "readOnly": true + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.", + "readOnly": true + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a disk supports hibernation." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "completionPercent": { + "type": "number", + "description": "Percentage complete for the background copy of disk restore point when source resource is from a different region." + }, + "replicationState": { + "type": "string", + "description": "Replication state of disk restore point when source resource is from a different region.", + "readOnly": true + }, + "sourceResourceLocation": { + "type": "string", + "description": "Location of source disk or source disk restore point when source resource is from a different region.", + "readOnly": true + }, + "securityProfile": { + "$ref": "./diskRPCommon.json#/definitions/DiskSecurityProfile", + "description": "Contains the security related information for the resource." + } + }, + "description": "Properties of an incremental disk restore point" + }, + "ProxyOnlyResource": { + "description": "The ProxyOnly Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + } + } + }, + "parameters": { + "DiskRestorePointNameParameter": { + "name": "diskRestorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk restore point created.", + "x-ms-parameter-location": "method" + }, + "RestorePointCollectionNameParameter": { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection that the disk restore point belongs.", + "x-ms-parameter-location": "method" + }, + "VmRestorePointNameParameter": { + "name": "vmRestorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vm restore point that the disk disk restore point belongs.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json new file mode 100644 index 000000000000..f341741c1a66 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approving myPrivateEndpointConnection" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myPrivateEndpointConenction", + "type": "Microsoft.Compute/diskAccesses/privateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName", + "properties": { + "provisioningState": "Updating", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Approving myPrivateEndpointConnection", + "status": "Approved" + } + } + } + }, + "200": { + "body": { + "name": "myPrivateEndpointConnectionName", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnectionName", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Approving myPrivateEndpointConnection", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json new file mode 100644 index 000000000000..5a273b919624 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskAccessName": "myDiskAccess", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json new file mode 100644 index 000000000000..0d2614b55121 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json new file mode 100644 index 000000000000..f2b89c1d01b8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myPrivateEndpointConnection", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json new file mode 100644 index 000000000000..6b2779b90ae7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateLinkResources/disks", + "name": "disks", + "type": "Microsoft.Compute/diskAccesses/privateLinkResources", + "properties": { + "groupId": "disks", + "requiredMembers": [ + "diskAccess_1" + ], + "requiredZoneNames": [ + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Create.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Create.json new file mode 100644 index 000000000000..8bdd080b0e1a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess", + "diskAccess": { + "location": "West US" + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess", + "location": "West US", + "type": "Microsoft.Compute/diskAccesses" + } + }, + "200": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Delete.json new file mode 100644 index 000000000000..4284102f8ec0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskAccessName": "myDiskAccess", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Get.json new file mode 100644 index 000000000000..6871e2aff201 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json new file mode 100644 index 000000000000..db2845d9f14f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json new file mode 100644 index 000000000000..d6672d79e9e6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + }, + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2/privateEndpoinConnections/myDiskAccess2.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint2" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2", + "name": "myDiskAccess2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_ListBySubscription.json new file mode 100644 index 000000000000..6c3a37f6c89f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_ListBySubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + }, + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2/privateEndpoinConnections/myDiskAccess2.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint2" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2", + "name": "myDiskAccess2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Update.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Update.json new file mode 100644 index 000000000000..88c23559fc10 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskAccessExamples/DiskAccess_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskAccessName": "myDiskAccess", + "diskAccess": { + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess?api-version=2021-04-01" + }, + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + }, + "200": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json new file mode 100644 index 000000000000..c61c70f201b8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json new file mode 100644 index 000000000000..ca8632454dbc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentSubscription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json new file mode 100644 index 000000000000..00d363c43a06 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Create_WithKeyVaultFromADifferentTenant.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}": {} + } + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferenttenant.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "federatedClientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}": {} + } + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferenttenant.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "federatedClientId": "00000000-0000-0000-0000-000000000000", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}": {} + } + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferenttenant.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "federatedClientId": "00000000-0000-0000-0000-000000000000", + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json new file mode 100644 index 000000000000..59107a3b619d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskEncryptionSetName": "myDiskEncryptionSet", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json new file mode 100644 index 000000000000..f0c95975a3bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json new file mode 100644 index 000000000000..64b051f3d565 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Get_WithAutoKeyRotationError.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "rotationToLatestKeyVersionEnabled": true, + "provisioningState": "Succeeded", + "autoKeyRotationError": { + "code": "ManagedServiceIdentityNotFound", + "message": "Auto-key rotation was disabled as managed service identity associated with DiskEncryptionSet 'myDiskEncryptionSet' was not found. Please update the resource with correct identity to re-enable auto-key rotation." + } + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json new file mode 100644 index 000000000000..d51484208ec6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListAssociatedResources.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "value": [ + "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/associatedResources?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json new file mode 100644 index 000000000000..fa0601ef7eb8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json new file mode 100644 index 000000000000..ebe488edde7b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/mySecondResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json new file mode 100644 index 000000000000..c004067435e7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey" + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2021-04-01" + }, + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [], + "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00" + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json new file mode 100644 index 000000000000..9ebff7ff453d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabled.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2021-04-01" + }, + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/KeyVersion2" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true, + "provisioningState": "Succeeded", + "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json new file mode 100644 index 000000000000..a9873b2ecf5c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_Update_WithRotationToLatestKeyVersionEnabledInProgress.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2021-04-01" + }, + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "previousKeys": [] + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion2" + }, + "encryptionType": "EncryptionAtRestWithCustomerKey", + "rotationToLatestKeyVersionEnabled": true, + "previousKeys": [ + { + "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1" + } + ], + "provisioningState": "Updating", + "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_BeginGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_BeginGetAccess.json new file mode 100644 index 000000000000..01019ebf5597 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_BeginGetAccess.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2023-04-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "fileFormat": "VHD" + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json new file mode 100644 index 000000000000..f6e0676770e7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_BeginGetAccess_WithVMGuestState.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2023-04-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "getSecureVMGuestStateSAS": true + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r", + "securityDataAccessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/b9bf5824-6122-49e0-ba22-042f76ccd8a1_vmgs?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json new file mode 100644 index 000000000000..645835dc5da7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_CreateOrUpdate_BurstingEnabled.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "diskSizeGB": 1024, + "burstingEnabled": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 1024, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 1024, + "burstingEnabled": true, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByCopyingASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByCopyingASnapshot.json new file mode 100644 index 000000000000..c35bf9cf427a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByCopyingASnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..aec206e12852 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByImportingBlobFromADifferentSubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..9c9104aed846 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ByImportingBlobFromTheSameSubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json new file mode 100644 index 000000000000..c2d2d985230e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_ConfidentialVMSupportedDiskEncryptedWithCMK.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "secureVMDiskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "secureVMDiskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_DiskEncryptedWithCustomerKey", + "secureVMDiskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_Empty.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_Empty.json new file mode 100644 index 000000000000..26f97ee835ab --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_Empty.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAPlatformImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAPlatformImage.json new file mode 100644 index 000000000000..c64ca6d11130 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAPlatformImage.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "{sku}", + "publisher": "{publisher}", + "product": "{offer}" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "{sku}", + "publisher": "{publisher}", + "product": "{offer}" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/westus/Publishers/{publisher}/ArtifactTypes/VMImage/Offers/{offer}/Skus/{sku}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json new file mode 100644 index 000000000000..5f565f587e69 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryCommunityImage.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "communityGalleryImageId": "/CommunityGalleries/{communityGalleryPublicGalleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "communityGalleryImageId": "/CommunityGalleries/{communityGalleryPublicGalleryName}/Images/{imageName}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "communityGalleryImageId": "/CommunityGalleries/{communityGalleryPublicGalleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json new file mode 100644 index 000000000000..91ca2e3567bf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryDirectSharedImage.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "sharedGalleryImageId": "/SharedGalleries/{sharedGalleryUniqueName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "sharedGalleryImageId": "/SharedGalleries/{sharedGalleryUniqueName}/Images/{imageName}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "sharedGalleryImageId": "/SharedGalleries/{sharedGalleryUniqueName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json new file mode 100644 index 000000000000..3c69d4cea791 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnAzureComputeGalleryImage.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "id": "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Providers/Microsoft.Compute/Galleries/{galleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "id": "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Providers/Microsoft.Compute/Galleries/{galleryName}/Images/{imageName}/Versions/1.0.0" + } + }, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "creationData": { + "createOption": "FromImage", + "galleryImageReference": { + "id": "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Providers/Microsoft.Compute/Galleries/{galleryName}/Images/{imageName}/Versions/1.0.0" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json new file mode 100644 index 000000000000..4fd7bc765989 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnElasticSanVolumeSnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json new file mode 100644 index 000000000000..20b5ac6e8d1a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromAnExistingManagedDisk.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk2", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromImportSecure.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromImportSecure.json new file mode 100644 index 000000000000..1936f7933dea --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromImportSecure.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" + }, + "creationData": { + "createOption": "ImportSecure", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "securityDataUri": "https://mystorageaccount.blob.core.windows.net/osimages/vmgs.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" + }, + "creationData": { + "createOption": "ImportSecure", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "securityDataUri": "https://mystorageaccount.blob.core.windows.net/osimages/vmgs.vhd" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "securityProfile": { + "securityType": "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" + }, + "creationData": { + "createOption": "ImportSecure", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "securityDataUri": "https://mystorageaccount.blob.core.windows.net/osimages/vmgs.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json new file mode 100644 index 000000000000..5b277db72cac --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_FromUploadPreparedSecure.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "UploadPreparedSecure", + "uploadSizeBytes": 10737418752 + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "UploadPreparedSecure", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "UploadPreparedSecure", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_InExtendedLocation.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_InExtendedLocation.json new file mode 100644 index 000000000000..42654943eb32 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_InExtendedLocation.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "extendedLocation": { + "type": "EdgeZone", + "name": "{edge-zone-id}" + }, + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "extendedLocation": { + "type": "EdgeZone", + "name": "{edge-zone-id}" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "extendedLocation": { + "type": "EdgeZone", + "name": "{edge-zone-id}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_PerformancePlus.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_PerformancePlus.json new file mode 100644 index 000000000000..724319c7758d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_PerformancePlus.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Upload", + "performancePlus": true + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "performancePlus": true + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "performancePlus": true + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_UploadDisk.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_UploadDisk.json new file mode 100644 index 000000000000..c475c4510dae --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_UploadDisk.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json new file mode 100644 index 000000000000..dc47ef265a99 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDataAccessAuthMode.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "dataAccessAuthMode": "AzureActiveDirectory" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "dataAccessAuthMode": "AzureActiveDirectory" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDiskAccess.json new file mode 100644 index 000000000000..6c97783829bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDiskAccess.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "networkAccessPolicy": "AllowPrivate", + "diskAccessId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/{existing-diskAccess-name}" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "networkAccessPolicy": "AllowPrivate", + "diskAccessId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/{existing-diskAccess-name}", + "publicNetworkAccess": "Enabled" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json new file mode 100644 index 000000000000..cbb023a3547b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithDiskEncryptionSet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "encryption": { + "diskEncryptionSetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "encryption": { + "diskEncryptionSetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithLogicalSectorSize.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithLogicalSectorSize.json new file mode 100644 index 000000000000..d205896964c6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithLogicalSectorSize.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "sku": { + "name": "UltraSSD_LRS" + }, + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 512 + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 512 + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 512 + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json new file mode 100644 index 000000000000..e0223b8f3bc2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithOptimizedForFrequentAttach.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "optimizedForFrequentAttach": true + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "optimizedForFrequentAttach": true + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "optimizedForFrequentAttach": true + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json new file mode 100644 index 000000000000..23dd5f9437cc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myPremiumV2Disk", + "disk": { + "location": "West US", + "sku": { + "name": "PremiumV2_LRS" + }, + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "diskIOPSReadWrite": 125, + "diskMBpsReadWrite": 3000 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myPremiumV2Disk", + "sku": { + "name": "PremiumV2_LRS", + "tier": "Premium" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myPremiumV2Disk", + "sku": { + "name": "PremiumV2_LRS", + "tier": "Premium" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json new file mode 100644 index 000000000000..a9ddd297de4f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "West US", + "sku": { + "name": "Premium_ZRS" + }, + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "Premium_ZRS", + "tier": "Premium" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk", + "sku": { + "name": "Premium_ZRS", + "tier": "Premium" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithSecurityProfile.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithSecurityProfile.json new file mode 100644 index 000000000000..8e12654057cc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithSecurityProfile.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "location": "North Central US", + "properties": { + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "North Central US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "name": "myDisk", + "location": "North Central US", + "properties": { + "provisioningState": "Succeeded", + "osType": "Windows", + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json new file mode 100644 index 000000000000..9b1a12a08174 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Create_WithUltraSSD_ReadOnly.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myUltraReadOnlyDisk", + "disk": { + "location": "West US", + "sku": { + "name": "UltraSSD_LRS" + }, + "properties": { + "creationData": { + "createOption": "Empty", + "logicalSectorSize": 4096 + }, + "diskSizeGB": 200, + "diskIOPSReadWrite": 125, + "diskMBpsReadWrite": 3000, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myUltraReadOnlyDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + } + }, + "location": "West US", + "name": "myUltraReadOnlyDisk", + "sku": { + "name": "UltraSSD_LRS", + "tier": "Ultra" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Delete.json new file mode 100644 index 000000000000..5aed3ee529dc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_EndGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_EndGetAccess.json new file mode 100644 index 000000000000..ec48fb7a026e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_EndGetAccess.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Get.json new file mode 100644 index 000000000000..0614e0d09802 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myManagedDisk" + }, + "responses": { + "200": { + "body": { + "managedBy": "/subscriptions/123caaa-123v-v211-a49f-f88ccac5bf88/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachines/TestVM414689371c88843d65ec", + "sku": { + "name": "Standard_LRS" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "test_sku", + "publisher": "test_test_pmc2pc1", + "product": "marketplace_vm_test" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "supportsHibernation": true, + "securityProfile": { + "securityType": "TrustedLaunch" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 10, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "LastOwnershipUpdateTime": "2016-12-28T04:41:35.079872+00:00", + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_ListByResourceGroup.json new file mode 100644 index 000000000000..58f5b0e64ceb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_ListByResourceGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_ListBySubscription.json new file mode 100644 index 000000000000..ec24280e962b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_ListBySubscription.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk3", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json new file mode 100644 index 000000000000..4e741cd0acad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddAcceleratedNetworking.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportedCapabilities": { + "acceleratedNetwork": false + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddDiskControllerTypes.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddDiskControllerTypes.json new file mode 100644 index 000000000000..0d22bd81410b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddDiskControllerTypes.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportedCapabilities": { + "diskControllerTypes": "SCSI" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2023-04-02" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "diskControllerTypes": "SCSI" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/marketplacetestfirstparty/ArtifactTypes/VMImage/Offers/nvme_test_062/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "diskControllerTypes": "SCSI" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/marketplacetestfirstparty/ArtifactTypes/VMImage/Offers/nvme_test_062/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddPurchasePlan.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddPurchasePlan.json new file mode 100644 index 000000000000..d276656f54f7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddPurchasePlan.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "purchasePlan": { + "name": "myPurchasePlanName", + "publisher": "myPurchasePlanPublisher", + "product": "myPurchasePlanProduct", + "promotionCode": "myPurchasePlanPromotionCode" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "myPurchasePlanName", + "publisher": "myPurchasePlanPublisher", + "product": "myPurchasePlanProduct", + "promotionCode": "myPurchasePlanPromotionCode" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "myPurchasePlanName", + "publisher": "myPurchasePlanPublisher", + "product": "myPurchasePlanProduct", + "promotionCode": "myPurchasePlanPromotionCode" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddSupportsHibernation.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddSupportsHibernation.json new file mode 100644 index 000000000000..e5848d4c50f7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_AddSupportsHibernation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportsHibernation": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportsHibernation": true, + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportsHibernation": true, + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_ChangeTier.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_ChangeTier.json new file mode 100644 index 000000000000..cd8aaa3bf46f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_ChangeTier.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "tier": "P30" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Updating", + "tier": "P10", + "propertyUpdatesInProgress": { + "targetTier": "P30" + } + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Succeeded", + "tier": "P30" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_DisableBursting.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_DisableBursting.json new file mode 100644 index 000000000000..a1113fdfbc5a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_DisableBursting.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "burstingEnabled": false + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_DisableOptimizedForFrequentAttach.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_DisableOptimizedForFrequentAttach.json new file mode 100644 index 000000000000..9eac63934f93 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_DisableOptimizedForFrequentAttach.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "optimizedForFrequentAttach": false + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "optimizedForFrequentAttach": false + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "optimizedForFrequentAttach": false + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_RemoveDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_RemoveDiskAccess.json new file mode 100644 index 000000000000..9ede234c7730 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_RemoveDiskAccess.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "networkAccessPolicy": "AllowAll" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-04-01" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "networkAccessPolicy": "AllowAll" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "networkAccessPolicy": "AllowAll" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_ToAddArchitecture.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_ToAddArchitecture.json new file mode 100644 index 000000000000..1725bfe2443c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskExamples/Disk_Update_ToAddArchitecture.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "diskName": "myDisk", + "disk": { + "properties": { + "supportedCapabilities": { + "architecture": "Arm64" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk?api-version=2021-12-01" + }, + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "architecture": "Arm64" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Updating" + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "westus", + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "supportedCapabilities": { + "architecture": "Arm64" + }, + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscription-id}/Providers/Microsoft.Compute/Locations/westus/Publishers/test_test_pmc2pc1/ArtifactTypes/VMImage/Offers/marketplace_vm_test/Skus/test_sku/Versions/1.0.0" + } + }, + "diskSizeGB": 127, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json new file mode 100644 index 000000000000..b1ec76f93be7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_BeginGetAccess.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2023-04-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "fileFormat": "VHDX" + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json new file mode 100644 index 000000000000..c78fe4e15def --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_EndGetAccess.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_Get.json new file mode 100644 index 000000000000..79fb6d5e892f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpc/restorePoints/vmrp/diskRestorePoints/TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "name": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "properties": { + "timeCreated": "2020-09-16T04:41:35.079872+00:00", + "sourceResourceId": "/subscriptions/d2260d06-e00d-422f-8b63-93df551a59ae/resourceGroups/rg0680fb0c-89f1-41b4-96c0-35733a181558/providers/Microsoft.Compute/disks/TestDisk45ceb03433006d1baee0", + "osType": "Windows", + "hyperVGeneration": "V1", + "familyId": "996bf3ce-b6ff-4e86-9db6-dc27ea06cea5", + "sourceUniqueId": "48e058b1-7eea-4968-b532-10a8a1130c13", + "networkAccessPolicy": "AllowAll", + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json new file mode 100644 index 000000000000..5060d8510062 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_Get_WhenSourceResourceIsFromDifferentRegion.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpc/restorePoints/vmrp/diskRestorePoints/TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "name": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "properties": { + "timeCreated": "2020-09-16T04:41:35.079872+00:00", + "sourceResourceId": "/subscriptions/d2260d06-e00d-422f-8b63-93df551a59ae/resourceGroups/rg0680fb0c-89f1-41b4-96c0-35733a181558/providers/Microsoft.Compute/disks/TestDisk45ceb03433006d1baee0", + "osType": "Windows", + "hyperVGeneration": "V1", + "familyId": "996bf3ce-b6ff-4e86-9db6-dc27ea06cea5", + "sourceUniqueId": "48e058b1-7eea-4968-b532-10a8a1130c13", + "networkAccessPolicy": "AllowAll", + "publicNetworkAccess": "Disabled", + "replicationState": "Succeeded", + "completionPercent": 100, + "sourceResourceLocation": "eastus2" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json new file mode 100644 index 000000000000..9659c2e62e24 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/diskRestorePointExamples/DiskRestorePoint_ListByVmRestorePoint.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpc/restorePoints/vmrp/diskRestorePoints/TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "name": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "properties": { + "timeCreated": "2020-09-16T04:41:35.079872+00:00", + "sourceResourceId": "/subscriptions/d2260d06-e00d-422f-8b63-93df551a59ae/resourceGroups/rg0680fb0c-89f1-41b4-96c0-35733a181558/providers/Microsoft.Compute/disks/TestDisk45ceb03433006d1baee0", + "osType": "Windows", + "hyperVGeneration": "V1", + "familyId": "996bf3ce-b6ff-4e86-9db6-dc27ea06cea5", + "sourceUniqueId": "48e058b1-7eea-4968-b532-10a8a1130c13", + "networkAccessPolicy": "AllowAll", + "publicNetworkAccess": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json new file mode 100644 index 000000000000..52b77e3b7a98 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2023-04-02", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300, + "fileFormat": "VHDX" + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..0009ed9d2edb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..7c4c6e284af4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json new file mode 100644 index 000000000000..3564c5ec46fe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "mySnapshot", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyFromSanSnapshot", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyFromSanSnapshot", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyFromSanSnapshot", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json new file mode 100644 index 000000000000..9ea2b424bbab --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json new file mode 100644 index 000000000000..62cd4a3a0872 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "CopyStart", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Delete.json new file mode 100644 index 000000000000..23733612a2d3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_EndGetAccess.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_EndGetAccess.json new file mode 100644 index 000000000000..619a94b73584 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_EndGetAccess.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2023-04-02" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2023-04-02" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Get.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Get.json new file mode 100644 index 000000000000..d19e40894f26 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "mySnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "test_sku", + "publisher": "test_test_pmc2pc1", + "product": "marketplace_vm_test" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "supportsHibernation": true, + "creationData": { + "createOption": "Copy", + "sourceResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "sourceUniqueId": "d633885d-d102-4481-901e-5b2413d1a7be" + }, + "diskSizeGB": 100, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json new file mode 100644 index 000000000000..85eb2364a466 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02", + "snapshotName": "myIncrementalSnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "hyperVGeneration": "V1", + "purchasePlan": { + "name": "test_sku", + "publisher": "test_test_pmc2pc1", + "product": "marketplace_vm_test" + }, + "supportedCapabilities": { + "acceleratedNetwork": true + }, + "supportsHibernation": true, + "creationData": { + "createOption": "Copy", + "sourceResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk", + "sourceUniqueId": "d633885d-d102-4481-901e-5b2413d1a7be" + }, + "diskSizeGB": 100, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "incremental": true, + "networkAccessPolicy": "0", + "diskState": "0", + "diskSizeBytes": 10737418240, + "uniqueId": "a395e9c1-fb9e-446e-a9ba-7b2fa0bcd305", + "incrementalSnapshotFamilyId": "d1a341d5-1ea7-4a85-b304-944ad8021639", + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/myIncrementalSnapshot", + "name": "myIncrementalSnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_ListByResourceGroup.json new file mode 100644 index 000000000000..a32acbb79bfa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_ListBySubscription.json new file mode 100644 index 000000000000..9e2ad028ce5c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-04-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.6630569+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "name": "mySnapshot1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.3247198+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Update.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Update.json new file mode 100644 index 000000000000..654484c64534 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Update.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2023-04-02", + "snapshot": { + "properties": { + "diskSizeGB": 20 + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot?api-version=2021-04-01" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "diskSizeGB": 20, + "provisioningState": "Updating" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "diskSizeGB": 20, + "provisioningState": "Succeeded" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json new file mode 100644 index 000000000000..e8e326c682fc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2023-04-02", + "snapshot": { + "properties": { + "diskSizeGB": 20, + "supportedCapabilities": { + "acceleratedNetwork": false + } + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot?api-version=2021-04-01" + }, + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "diskSizeGB": 20, + "provisioningState": "Updating" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "supportedCapabilities": { + "acceleratedNetwork": false + }, + "diskSizeGB": 20, + "provisioningState": "Succeeded" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json new file mode 100644 index 000000000000..16df843e7d72 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json @@ -0,0 +1,676 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2023-04-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}": { + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "description": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "Snapshot object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Create a snapshot from an existing snapshot in the same or a different subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshot.json" + }, + "Create a snapshot by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromTheSameSubscription.json" + }, + "Create a snapshot by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_ByImportingAnUnmanagedBlobFromADifferentSubscription.json" + }, + "Create a snapshot from an existing snapshot in the same or a different subscription in a different region.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnExistingSnapshotInDifferentRegion.json" + }, + "Create a snapshot from an elastic san volume snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Create_FromAnElasticSanVolumeSnapshot.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "description": "Updates (patches) a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotUpdate" + }, + "description": "Snapshot object supplied in the body of the Patch snapshot operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Update a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Update.json" + }, + "Update a snapshot with accelerated networking.": { + "$ref": "./examples/snapshotExamples/Snapshot_Update_WithAcceleratedNetwork.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "description": "Gets information about a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Get information about a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Get.json" + }, + "Get information about an incremental snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_GetIncrementalSnapshot.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "description": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the snapshot is deleted, this is an expected error code." + } + }, + "x-ms-examples": { + "Delete a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "description": "Lists snapshots under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a resource group.": { + "$ref": "./examples/snapshotExamples/Snapshot_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "description": "Lists snapshots under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a subscription.": { + "$ref": "./examples/snapshotExamples/Snapshot_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_GrantAccess", + "description": "Grants access to a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "./diskRPCommon.json#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get snapshot access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./diskRPCommon.json#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Get a sas on a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_BeginGetAccess.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RevokeAccess", + "description": "Revokes access to a snapshot.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-examples": { + "Revoke access to a snapshot.": { + "$ref": "./examples/snapshotExamples/Snapshot_EndGetAccess.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Snapshot": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "Unused. Always Null." + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location where the snapshot will be created. Extended location cannot be changed." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Snapshot resource." + }, + "SnapshotUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + } + }, + "description": "Snapshot update resource." + }, + "SnapshotList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "A list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." + } + }, + "required": [ + "value" + ], + "description": "The List Snapshots operation response." + }, + "SnapshotSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ], + "x-ms-enum": { + "name": "SnapshotStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage" + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage" + }, + { + "value": "Standard_ZRS", + "description": "Standard zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot" + }, + "SnapshotProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the snapshot was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "purchasePlan": { + "$ref": "./diskRPCommon.json#/definitions/PurchasePlan", + "description": "Purchase plan information for the image from which the source disk for the snapshot was originally created." + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the source disk from the snapshot was originally created." + }, + "creationData": { + "$ref": "./diskRPCommon.json#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "diskState": { + "$ref": "./diskRPCommon.json#/definitions/DiskState", + "description": "The state of the snapshot." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "incremental": { + "type": "boolean", + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "incrementalSnapshotFamilyId": { + "type": "string", + "readOnly": true, + "description": "Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "securityProfile": { + "$ref": "./diskRPCommon.json#/definitions/DiskSecurityProfile", + "description": "Contains the security related information for the resource." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a snapshot supports hibernation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "completionPercent": { + "type": "number", + "description": "Percentage complete for the background copy when a resource is created via the CopyStart operation." + }, + "copyCompletionError": { + "$ref": "./diskRPCommon.json#/definitions/CopyCompletionError", + "description": "Indicates the error details if the background copy of a resource created via the CopyStart operation fails." + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "./diskRPCommon.json#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "encryption": { + "$ref": "./diskRPCommon.json#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "./diskRPCommon.json#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "supportsHibernation": { + "type": "boolean", + "description": "Indicates the OS on a snapshot supports hibernation." + }, + "publicNetworkAccess": { + "$ref": "./diskRPCommon.json#/definitions/PublicNetworkAccess" + }, + "dataAccessAuthMode": { + "$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode" + }, + "supportedCapabilities": { + "$ref": "./diskRPCommon.json#/definitions/SupportedCapabilities", + "description": "List of supported capabilities for the image from which the OS disk was created." + } + }, + "description": "Snapshot resource update properties." + } + }, + "parameters": { + "SnapshotNameParameter": { + "name": "snapshotName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index bbac295341bb..b57c123405b1 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2023-01-02 +tag: package-2023-04-02 directive: - where: @@ -248,6 +248,58 @@ directive: where: - $.definitions.VirtualMachineScaleSetVMExtension ``` + +### Tag: package-2023-04-02 + +These settings apply only when `--tag=package-2023-04-02` is specified on the command line. + +``` yaml $(tag) == 'package-2023-04-02' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/image.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2023-03-01/runCommand.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json + - Microsoft.Compute/Skus/stable/2021-07-01/skus.json + - Microsoft.Compute/GalleryRP/stable/2022-03-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2022-03-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2022-03-03/communityGallery.json + - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json +``` + +### Tag: package-2023-04-02-only + +These settings apply only when `--tag=package-2023-04-02-only` is specified on the command line. + +```yaml $(tag) == 'package-2023-04-02-only' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json +``` + + ### Tag: package-2023-01-02 These settings apply only when `--tag=package-2023-01-02` is specified on the command line. diff --git a/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json b/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json index 382570ddf7e8..3ddab8760664 100644 --- a/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json +++ b/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json @@ -33,26 +33,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of Proposal items", - "properties": { - "value": { - "type": "array", - "description": "The Proposal items on this page", - "items": { - "$ref": "#/definitions/Proposals.Proposal" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedProposal" }, "headers": { "x-ms-ccf-transaction-id": { @@ -916,26 +897,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of Member items", - "properties": { - "value": { - "type": "array", - "description": "The Member items on this page", - "items": { - "$ref": "#/definitions/ServiceState.Member" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedMember" }, "headers": { "x-ms-ccf-transaction-id": { @@ -1032,26 +994,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of Node items", - "properties": { - "value": { - "type": "array", - "description": "The Node items on this page", - "items": { - "$ref": "#/definitions/ServiceState.Node" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedNode" }, "headers": { "x-ms-ccf-transaction-id": { @@ -1292,6 +1235,72 @@ } } }, + "PagedMember": { + "type": "object", + "description": "Paged collection of Member items", + "properties": { + "value": { + "type": "array", + "description": "The Member items on this page", + "items": { + "$ref": "#/definitions/ServiceState.Member" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedNode": { + "type": "object", + "description": "Paged collection of Node items", + "properties": { + "value": { + "type": "array", + "description": "The Node items on this page", + "items": { + "$ref": "#/definitions/ServiceState.Node" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedProposal": { + "type": "object", + "description": "Paged collection of Proposal items", + "properties": { + "value": { + "type": "array", + "description": "The Proposal items on this page", + "items": { + "$ref": "#/definitions/Proposals.Proposal" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "Proposals.Action": { "type": "object", "description": "A single step in a proposed change to the service.", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md index 39c5166874f5..f701016d1f4f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.java.md @@ -78,6 +78,20 @@ batch: - tag: package-2023-05 - tag: package-preview-2023-06 - tag: package-2023-06 + - tag: package-2023-07 +``` + +### Tag: package-2023-07 and java + +These settings apply only when `--tag=package-2023-07` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2023-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2023_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2023_07_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2023-06 and java diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 3cbd5a80cc9f..01b0e483ca7f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -34,14 +34,23 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2023-06 +tag: package-2023-07 ``` + +### Tag: package-2023-07 + +These settings apply only when `--tag=package-2023-07` is specified on the command line. + +```yaml $(tag) == 'package-2023-07' +input-file: + - stable/2023-07-01/managedClusters.json +``` ### Tag: package-2023-06 These settings apply only when `--tag=package-2023-06` is specified on the command line. -```yaml $(tag) == 'package-2023-06' +``` yaml $(tag) == 'package-2023-06' input-file: - stable/2023-06-01/managedClusters.json ``` diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md index f16b8f165a6d..df209539d55f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.python.md @@ -16,9 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package ```yaml $(python) -default-api-version: "2023-06-01" +default-api-version: "2023-07-01" multiapi: true batch: + - tag: package-2023-07 - tag: package-2023-06 - tag: package-preview-2023-06 - tag: package-2023-05 @@ -90,6 +91,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2023-07 and python + +These settings apply only when `--tag=package-2023-07 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-07' && $(python) +namespace: azure.mgmt.containerservice.v2023_07_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2023_07_01 +``` + ### Tag: package-2023-06 and python These settings apply only when `--tag=package-2023-06 --python` is specified on the command line. diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..512f7ad774fe --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-07-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..72414eddf9b8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..2d226d275d18 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..6cffa677de66 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..d6bfb0239258 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..46b91b52347b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..9268cb3a6caf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..46d88a2c3b0e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..df1a63aca2a7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..92a6545068de --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..3cd4d9269162 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..988b51ec9408 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..c659796e25ae --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..13bb70a6162b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..a395c715ac87 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..d3f3cceb76a8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..5f8eab4238c6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..82cfa487cf8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..d931b10e5649 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..738f0c7aa16e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..e79afc0f3a6d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Start.json new file mode 100644 index 000000000000..e476a5b9a069 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..f4ba9befe48e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..f34d96ae06a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ContainerServiceGetOSOptions.json new file mode 100644 index 000000000000..e10fd7f00210 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ContainerServiceGetOSOptions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/locations/location1/osOptions/default", + "name": "default", + "type": "Microsoft.ContainerService/locations/osOptions", + "properties": { + "osOptionPropertyList": [ + { + "os-type": "Linux", + "enable-fips-image": false + }, + { + "os-type": "Windows", + "enable-fips-image": false + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..8c5c2616721f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/KubernetesVersions_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..dbb64efbc340 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..214315e4a913 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..2cc7c160d6a1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..8666cabf97b0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..1eb11cd585c1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..f209f2a8f761 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..128c33464d3d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..913056c8371f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedAutoUpgradeSchedule", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..620582c2b0c0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-07-01" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..bdda4c1674dc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..a727da2c6d18 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..db85538260bf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..332e17e095f1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.22.1", + "currentKubernetesVersion": "1.22.1", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.22.1", + "currentOrchestratorVersion": "1.22.1", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..844ae7b9b934 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..cc774b82829e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..854df18e712d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..aa19962958f2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..aeb27573d25e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..ab3e41e79ee0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..110426effa74 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..af0b4a67320b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..3f5c4937ceec --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..609c1bb6d27b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..97ff779897df --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..4a19308e7b85 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..3e325acb1ca2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..6547ae878c3b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + } + }, + "workloadIdentity": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..cef0771dfd06 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..e7e226375163 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..424cfe602db1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..23dea45aec0b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..add8c2c1f253 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..b046640e155f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..fa6c42a96185 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..067d094e8bee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGet.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..ed2d58999cd8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..6d27106d09f8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..d99e399c2cf7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..bbf25ac039fe --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "currentKubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterAdminCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterAdminCredentials.json new file mode 100644 index 000000000000..244e27972623 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterAdminCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json new file mode 100644 index 000000000000..244e27972623 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterMonitoringUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterUserCredentials.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterUserCredentials.json new file mode 100644 index 000000000000..244e27972623 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersListClusterUserCredentials.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..d1fe30d1676b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..73bb108f3413 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..fa6c42a96185 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..fa6c42a96185 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..fa6c42a96185 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..fa6c42a96185 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..2068ee2755d6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/Operation_List.json new file mode 100644 index 000000000000..85f1772e59e5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/Operation_List.json @@ -0,0 +1,3583 @@ +{ + "parameters": { + "api-version": "2023-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets OS options", + "operation": "Get OS Options", + "provider": "Microsoft Container Service", + "resource": "OSOptions" + }, + "name": "Microsoft.ContainerService/locations/osOptions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..fe9a62f93bb7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..d9db334abaf1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..2b406af867b1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..2a7f45bde941 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..6e0e71ede59b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..2caa01bcee15 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..a17bd147498b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..db6a7165d8d0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-07-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..87c9211f832e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..9b1f0fe19ecb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2023-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..6286e320ccc2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..22f65511fe33 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsGet.json new file mode 100644 index 000000000000..8c94f413f57d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsList.json new file mode 100644 index 000000000000..dd9c565a2260 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..a051e7a53f02 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..22f03c52f561 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/managedClusters.json new file mode 100644 index 000000000000..23c8e0641110 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/managedClusters.json @@ -0,0 +1,6469 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2023-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetOSOptions", + "summary": "Gets supported OS options in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSOptionProfile" + } + } + }, + "x-ms-examples": { + "Get Container Service OS Options": { + "$ref": "./examples/ContainerServiceGetOSOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterMonitoringUserCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + }, + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + }, + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + }, + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + }, + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool." + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Agent Pool is running.", + "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "title": "Whether the Agent Pool is running or stopped.", + "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "title": "The drain timeout for a node", + "description": "The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length:** 1 character

**Max-length:** 20 characters" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "title": "Whether to enable Windows gMSA.", + "description": "Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + }, + "rootDomainName": { + "type": "string", + "description": "Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Used with networkPlugin=azure, pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet's method of route tables. For more information visit https://aka.ms/aks/azure-cni-overlay." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign pod IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The CIDR notation IP ranges from which to assign service cluster IPs.", + "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "title": "The IP families used to specify IP versions available to the cluster.", + "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First week of the month." + }, + { + "value": "Second", + "description": "Second week of the month." + }, + { + "value": "Third", + "description": "Third week of the month." + }, + { + "value": "Fourth", + "description": "Fourth week of the month." + }, + { + "value": "Last", + "description": "Last week of the month." + } + ] + }, + "title": "The week index.", + "description": "Specifies on which week of the month the dayOfWeek applies." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "title": "A date range.", + "description": "For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes specified by the user.", + "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "title": "PublicNetworkAccess of the managedCluster", + "description": "Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "NodeImage" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially and will be patched at some point by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + } + ] + }, + "title": "Node OS Upgrade Channel", + "description": "Manner in which the OS on your nodes is updated. The default is NodeImage." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner", + "AzureLinux", + "Windows2019", + "Windows2022" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + } + ] + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "type": "object", + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "type": "object", + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "x-ms-identifiers": [], + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "title": "Network access of the key vault", + "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "description": "VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA. Default value is false.", + "default": false + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Azure Monitor addon profiles for monitoring the managed cluster.", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels." + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling." + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json index 0c8228d8dd2e..21c43ef5790f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json @@ -269,13 +269,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Fleet' update operation succeeded", "schema": { "$ref": "#/definitions/Fleet" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Fleet' create operation succeeded", "schema": { "$ref": "#/definitions/Fleet" }, @@ -665,13 +665,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'FleetMember' update operation succeeded", "schema": { "$ref": "#/definitions/FleetMember" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'FleetMember' create operation succeeded", "schema": { "$ref": "#/definitions/FleetMember" }, diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json index 415fdbc2001e..d14d3d59f4e0 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json @@ -272,13 +272,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Fleet' update operation succeeded", "schema": { "$ref": "#/definitions/Fleet" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Fleet' create operation succeeded", "schema": { "$ref": "#/definitions/Fleet" }, @@ -668,13 +668,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'FleetMember' update operation succeeded", "schema": { "$ref": "#/definitions/FleetMember" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'FleetMember' create operation succeeded", "schema": { "$ref": "#/definitions/FleetMember" }, @@ -1035,13 +1035,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'UpdateRun' update operation succeeded", "schema": { "$ref": "#/definitions/UpdateRun" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'UpdateRun' create operation succeeded", "schema": { "$ref": "#/definitions/UpdateRun" }, diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json index c6658714b8d3..aca1698b9abb 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json @@ -52,26 +52,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "type": "object", - "description": "Paged collection of WidgetSuite items", - "properties": { - "value": { - "type": "array", - "description": "The WidgetSuite items on this page", - "items": { - "$ref": "#/definitions/WidgetSuite" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] + "$ref": "#/definitions/PagedWidgetSuite" } }, "default": { @@ -210,7 +191,8 @@ "Widgets_CreateOrUpdateWidget": { "$ref": "./examples/Widgets_CreateOrUpdateWidgetSample.json" } - } + }, + "x-ms-long-running-operation": true }, "delete": { "operationId": "Widgets_DeleteWidget", @@ -277,7 +259,8 @@ "Delete widget by widget name using long-running operation.": { "$ref": "./examples/Widgets_DeleteWidgetSample.json" } - } + }, + "x-ms-long-running-operation": true } }, "/widgets/{widgetName}/operations/{operationId}": { @@ -486,6 +469,28 @@ } } }, + "PagedWidgetSuite": { + "type": "object", + "description": "Paged collection of WidgetSuite items", + "properties": { + "value": { + "type": "array", + "description": "The WidgetSuite items on this page", + "items": { + "$ref": "#/definitions/WidgetSuite" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "Versions": { "type": "string", "description": "Versions info.", diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json index 664ad8fa9024..92b62818ddbb 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBMongoDBDatabasePartitionMerge.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "api-version": "2023-03-15-preview", - "subscriptionId": "subid", - "resourceGroupName": "rgName", - "accountName": "ddb1", - "databaseName": "databaseName", - "mergeParameters": { - "isDryRun": false - } - }, - "responses": { - "200": { - "body": { - "physicalPartitionStorageInfoCollection": [ - { - "storageInKB": 333.0, - "id": "0" - }, - { - "storageInKB": 305.0, - "id": "1" - }, - { - "storageInKB": 368.0, - "id": "177" - }, - { - "storageInKB": 96313.0, - "id": "178" - }, - { - "storageInKB": 194.0, - "id": "5" - }, - { - "storageInKB": 331.0, - "id": "6" - }, - { - "storageInKB": 384.0, - "id": "7" - }, - { - "storageInKB": 246.0, - "id": "8" - } - ] - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2023-03-15-preview", - "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2023-03-15-preview" - } - } - } -} +{ + "parameters": { + "api-version": "2023-03-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "mergeParameters": { + "isDryRun": false + } + }, + "responses": { + "200": { + "body": { + "physicalPartitionStorageInfoCollection": [ + { + "storageInKB": 333.0, + "id": "0" + }, + { + "storageInKB": 305.0, + "id": "1" + }, + { + "storageInKB": 368.0, + "id": "177" + }, + { + "storageInKB": 96313.0, + "id": "178" + }, + { + "storageInKB": 194.0, + "id": "5" + }, + { + "storageInKB": 331.0, + "id": "6" + }, + { + "storageInKB": 384.0, + "id": "7" + }, + { + "storageInKB": 246.0, + "id": "8" + } + ] + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2023-03-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2023-03-15-preview" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json index 7c561c50bbd6..761c39bcb818 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-15-preview/examples/CosmosDBSqlDatabasePartitionMerge.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "api-version": "2023-03-15-preview", - "subscriptionId": "subid", - "resourceGroupName": "rgName", - "accountName": "ddb1", - "databaseName": "databaseName", - "mergeParameters": { - "isDryRun": false - } - }, - "responses": { - "200": { - "body": { - "physicalPartitionStorageInfoCollection": [ - { - "storageInKB": 333.0, - "id": "0" - }, - { - "storageInKB": 305.0, - "id": "1" - }, - { - "storageInKB": 368.0, - "id": "177" - }, - { - "storageInKB": 96313.0, - "id": "178" - }, - { - "storageInKB": 194.0, - "id": "5" - }, - { - "storageInKB": 331.0, - "id": "6" - } - ] - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2022-11-15-preview", - "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2022-11-15-preview" - } - } - } -} +{ + "parameters": { + "api-version": "2023-03-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "mergeParameters": { + "isDryRun": false + } + }, + "responses": { + "200": { + "body": { + "physicalPartitionStorageInfoCollection": [ + { + "storageInKB": 333.0, + "id": "0" + }, + { + "storageInKB": 305.0, + "id": "1" + }, + { + "storageInKB": 368.0, + "id": "177" + }, + { + "storageInKB": 96313.0, + "id": "178" + }, + { + "storageInKB": 194.0, + "id": "5" + }, + { + "storageInKB": 331.0, + "id": "6" + } + ] + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2022-11-15-preview", + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2022-11-15-preview" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json index ee6cfedd9ccb..7ae28d4a1eec 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json @@ -1,2986 +1,2986 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-01-23-preview", - "title": "Desktop Virtualization API Client" - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "host": "management.azure.com", - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.DesktopVirtualization/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "List all of the available operations the Desktop Virtualization resource provider supports.", - "x-ms-examples": { - "OperationDescription_List": { - "$ref": "./examples/OperationDescription_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved operations.", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationList" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Get", - "description": "Get a workspace.", - "x-ms-examples": { - "Workspace_Get": { - "$ref": "./examples/Workspace_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_CreateOrUpdate", - "description": "Create or update a workspace.", - "x-ms-examples": { - "Workspace_Create": { - "$ref": "./examples/Workspace_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspace", - "description": "Object containing Workspace definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "201": { - "description": "Successfully created workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Delete", - "description": "Remove a workspace.", - "x-ms-examples": { - "Workspace_Delete": { - "$ref": "./examples/Workspace_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted workspace." - }, - "204": { - "description": "Workspace does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Update", - "description": "Update a workspace.", - "x-ms-examples": { - "Workspace_Update": { - "$ref": "./examples/Workspace_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspace", - "description": "Object containing Workspace definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/WorkspacePatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListByResourceGroup", - "description": "List workspaces.", - "x-ms-examples": { - "Workspace_ListByResourceGroup": { - "$ref": "./examples/Workspace_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspaces in resource group.", - "schema": { - "$ref": "#/definitions/WorkspaceList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListBySubscription", - "description": "List workspaces in subscription.", - "x-ms-examples": { - "Workspace_ListBySubscription": { - "$ref": "./examples/Workspace_ListBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspaces in subscription.", - "schema": { - "$ref": "#/definitions/WorkspaceList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Get", - "description": "Get an application group.", - "x-ms-examples": { - "ApplicationGroup_Get": { - "$ref": "./examples/ApplicationGroup_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_CreateOrUpdate", - "description": "Create or update an applicationGroup.", - "x-ms-examples": { - "ApplicationGroup_Create": { - "$ref": "./examples/ApplicationGroup_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "applicationGroup", - "description": "Object containing ApplicationGroup definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "201": { - "description": "Successfully created application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Delete", - "description": "Remove an applicationGroup.", - "x-ms-examples": { - "ApplicationGroup_Delete": { - "$ref": "./examples/ApplicationGroup_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully removed application group." - }, - "204": { - "description": "Application group does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Update", - "description": "Update an applicationGroup.", - "x-ms-examples": { - "ApplicationGroups_Update": { - "$ref": "./examples/ApplicationGroup_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "applicationGroup", - "description": "Object containing ApplicationGroup definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApplicationGroupPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_ListByResourceGroup", - "description": "List applicationGroups.", - "x-ms-examples": { - "ApplicationGroup_ListByResourceGroup": { - "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application groups in resource group.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_ListBySubscription", - "description": "List applicationGroups in subscription.", - "x-ms-examples": { - "ApplicationGroup_List": { - "$ref": "./examples/ApplicationGroup_ListBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application groups in subscription.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { - "get": { - "tags": [ - "StartMenuItem" - ], - "operationId": "StartMenuItems_List", - "description": "List start menu items in the given application group.", - "x-ms-examples": { - "StartMenuItem_List": { - "$ref": "./examples/StartMenuItem_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved start menu items in application group.", - "schema": { - "$ref": "#/definitions/StartMenuItemList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_Get", - "description": "Get an application.", - "x-ms-examples": { - "Application_Get": { - "$ref": "./examples/Application_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "Application" - ], - "operationId": "Applications_CreateOrUpdate", - "description": "Create or update an application.", - "x-ms-examples": { - "Application_Create": { - "$ref": "./examples/Application_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "name": "application", - "description": "Object containing Application definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Application" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "201": { - "description": "Successfully created application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Application" - ], - "operationId": "Applications_Delete", - "description": "Remove an application.", - "x-ms-examples": { - "Application_Delete": { - "$ref": "./examples/Application_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully removed application." - }, - "204": { - "description": "Application does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Application" - ], - "operationId": "Applications_Update", - "description": "Update an application.", - "x-ms-examples": { - "Application_Update": { - "$ref": "./examples/Application_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "name": "application", - "description": "Object containing Application definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApplicationPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_List", - "description": "List applications.", - "x-ms-examples": { - "Applications_List": { - "$ref": "./examples/Application_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved applications in application group.", - "schema": { - "$ref": "#/definitions/ApplicationList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { - "get": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_Get", - "description": "Get a desktop.", - "x-ms-examples": { - "Desktop_Get": { - "$ref": "./examples/Desktop_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/DesktopNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved desktop.", - "schema": { - "$ref": "#/definitions/Desktop" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_Update", - "description": "Update a desktop.", - "x-ms-examples": { - "Desktop_Update": { - "$ref": "./examples/Desktop_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/DesktopNameParameter" - }, - { - "name": "desktop", - "description": "Object containing Desktop definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DesktopPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated desktop.", - "schema": { - "$ref": "#/definitions/Desktop" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { - "get": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_List", - "description": "List desktops.", - "x-ms-examples": { - "Desktop_List": { - "$ref": "./examples/Desktop_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved desktops in application group.", - "schema": { - "$ref": "#/definitions/DesktopList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Get", - "description": "Get a host pool.", - "x-ms-examples": { - "HostPool_Get": { - "$ref": "./examples/HostPool_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_CreateOrUpdate", - "description": "Create or update a host pool.", - "x-ms-examples": { - "HostPool_Create": { - "$ref": "./examples/HostPool_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "hostPool", - "description": "Object containing HostPool definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HostPool" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "201": { - "description": "Successfully created host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Delete", - "description": "Remove a host pool.", - "x-ms-examples": { - "HostPool_Delete": { - "$ref": "./examples/HostPool_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to delete sessionHost." - } - ], - "responses": { - "200": { - "description": "Successfully removed host pool." - }, - "204": { - "description": "Host pool does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Update", - "description": "Update a host pool.", - "x-ms-examples": { - "HostPool_Update": { - "$ref": "./examples/HostPool_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "hostPool", - "description": "Object containing HostPool definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/HostPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_ListByResourceGroup", - "description": "List hostPools.", - "x-ms-examples": { - "HostPool_ListByResourceGroup": { - "$ref": "./examples/HostPool_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool in resource group.", - "schema": { - "$ref": "#/definitions/HostPoolList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_List", - "description": "List hostPools in subscription.", - "x-ms-examples": { - "HostPool_List": { - "$ref": "./examples/HostPool_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool in subscription.", - "schema": { - "$ref": "#/definitions/HostPoolList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_ListByHostPool", - "description": "List userSessions.", - "x-ms-examples": { - "UserSession_ListByHostPool": { - "$ref": "./examples/UserSession_ListByHostPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user sessions in host pool.", - "schema": { - "$ref": "#/definitions/UserSessionList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { - "get": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Get", - "description": "Get a session host.", - "x-ms-examples": { - "SessionHost_Get": { - "$ref": "./examples/SessionHost_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved session host.", - "schema": { - "$ref": "#/definitions/SessionHost" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Delete", - "description": "Remove a SessionHost.", - "x-ms-examples": { - "SessionHost_Delete": { - "$ref": "./examples/SessionHost_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to force sessionHost deletion even when userSession exists." - } - ], - "responses": { - "200": { - "description": "Successfully removed session host." - }, - "204": { - "description": "Session host does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Update", - "description": "Update a session host.", - "x-ms-examples": { - "SessionHost_Update": { - "$ref": "./examples/SessionHost_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "sessionHost", - "description": "Object containing SessionHost definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SessionHostPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated session host.", - "schema": { - "$ref": "#/definitions/SessionHost" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { - "get": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_List", - "description": "List sessionHosts.", - "x-ms-examples": { - "SessionHost_List": { - "$ref": "./examples/SessionHost_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved session hosts in host pool.", - "schema": { - "$ref": "#/definitions/SessionHostList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Get", - "description": "Get a userSession.", - "x-ms-examples": { - "UserSession_Get": { - "$ref": "./examples/UserSession_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user session.", - "schema": { - "$ref": "#/definitions/UserSession" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Delete", - "description": "Remove a userSession.", - "x-ms-examples": { - "UserSession_Delete": { - "$ref": "./examples/UserSession_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to login off userSession." - } - ], - "responses": { - "200": { - "description": "Successfully removed user session." - }, - "204": { - "description": "User session does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_List", - "description": "List userSessions.", - "x-ms-examples": { - "UserSession_List": { - "$ref": "./examples/UserSession_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user sessions in session host.", - "schema": { - "$ref": "#/definitions/UserSessionList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { - "post": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Disconnect", - "description": "Disconnect a userSession.", - "x-ms-examples": { - "UserSession_Disconnect_Post": { - "$ref": "./examples/UserSession_Disconnect_Post.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully disconnected user session." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { - "post": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_SendMessage", - "description": "Send a message to a user.", - "x-ms-examples": { - "UserSession_SendMessage_Post": { - "$ref": "./examples/UserSession_SendMessage_Post.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - }, - { - "name": "sendMessage", - "description": "Object containing message includes title and message body", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SendMessage" - } - } - ], - "responses": { - "200": { - "description": "Successfully sent message to user session." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "CloudError": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error response of an operation failure" - }, - "ResourceProviderOperationList": { - "description": "Result of the request to list operations.", - "readOnly": true, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperation" - }, - "description": "List of operations supported by this resource provider." - } - } - }, - "ResourceProviderOperation": { - "description": "Supported operation of this resource provider.", - "readOnly": true, - "properties": { - "name": { - "description": "Operation name, in format of {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Resource provider: Microsoft Desktop Virtualization.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "Type of operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of this operation.", - "type": "string" - } - } - } - } - }, - "Workspace": { - "type": "object", - "description": "Represents a Workspace definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for Workspace", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspaceProperties" - } - } - }, - "WorkspaceProperties": { - "description": "Schema for Workspace properties.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Workspace." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Workspace." - }, - "applicationGroupReferences": { - "type": "array", - "description": "List of applicationGroup resource Ids.", - "items": { - "type": "string" - } - } - } - }, - "WorkspaceList": { - "type": "object", - "title": "WorkspaceList", - "description": "List of Workspace definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Workspace definitions.", - "items": { - "$ref": "#/definitions/Workspace" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "WorkspacePatch": { - "type": "object", - "description": "Workspace properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Workspace", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspacePatchProperties" - } - } - }, - "WorkspacePatchProperties": { - "description": "Workspace properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Workspace." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Workspace." - }, - "applicationGroupReferences": { - "type": "array", - "description": "List of applicationGroup links.", - "items": { - "type": "string" - } - } - } - }, - "ApplicationGroup": { - "type": "object", - "description": "Represents a ApplicationGroup definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for ApplicationGroup", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGroupProperties" - } - } - }, - "ApplicationGroupProperties": { - "description": "Schema for ApplicationGroup properties.", - "type": "object", - "required": [ - "hostPoolArmPath", - "applicationGroupType" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of ApplicationGroup." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of ApplicationGroup." - }, - "hostPoolArmPath": { - "type": "string", - "description": "HostPool arm path of ApplicationGroup.", - "x-nullable": false - }, - "workspaceArmPath": { - "type": "string", - "description": "Workspace arm path of ApplicationGroup.", - "readOnly": true - }, - "applicationGroupType": { - "enum": [ - "RemoteApp", - "Desktop" - ], - "x-ms-enum": { - "name": "ApplicationGroupType", - "modelAsString": true - }, - "type": "string", - "description": "Resource Type of ApplicationGroup.", - "x-nullable": false - } - } - }, - "ApplicationGroupPatch": { - "type": "object", - "description": "ApplicationGroup properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "ApplicationGroup properties that can be patched.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGroupPatchProperties" - } - } - }, - "ApplicationGroupPatchProperties": { - "description": "ApplicationGroup properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of ApplicationGroup." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of ApplicationGroup." - } - } - }, - "ApplicationGroupList": { - "type": "object", - "title": "ApplicationGroupList", - "description": "List of ApplicationGroup definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of ApplicationGroup definitions.", - "items": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "HostPool": { - "type": "object", - "description": "Represents a HostPool definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for HostPool", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HostPoolProperties" - } - } - }, - "HostPoolProperties": { - "description": "Properties of HostPool.", - "type": "object", - "required": [ - "hostPoolType", - "loadBalancerType", - "preferredAppGroupType" - ], - "properties": { - "friendlyName": { - "type": "string", - "description": "Friendly name of HostPool." - }, - "description": { - "type": "string", - "description": "Description of HostPool." - }, - "hostPoolType": { - "enum": [ - "Personal", - "Shared" - ], - "x-ms-enum": { - "name": "HostPoolType", - "modelAsString": true - }, - "type": "string", - "description": "HostPool type for desktop.", - "x-nullable": false - }, - "personalDesktopAssignmentType": { - "enum": [ - "Automatic", - "Direct" - ], - "x-ms-enum": { - "name": "PersonalDesktopAssignmentType", - "modelAsString": true - }, - "type": "string", - "description": "PersonalDesktopAssignment type for HostPool.", - "x-nullable": false - }, - "customRdpProperty": { - "type": "string", - "description": "Custom rdp property of HostPool." - }, - "maxSessionLimit": { - "type": "integer", - "description": "The max session limit of HostPool." - }, - "loadBalancerType": { - "enum": [ - "BreadthFirst", - "DepthFirst", - "Persistent" - ], - "x-ms-enum": { - "name": "LoadBalancerType", - "modelAsString": true - }, - "type": "string", - "description": "The type of the load balancer.", - "x-nullable": false - }, - "ring": { - "type": "integer", - "description": "The ring number of HostPool." - }, - "validationEnvironment": { - "type": "boolean", - "description": "Is validation environment." - }, - "registrationInfo": { - "$ref": "#/definitions/RegistrationInfo", - "description": "The registration info of HostPool." - }, - "vmTemplate": { - "type": "string", - "description": "VM template for sessionhosts configuration within hostpool." - }, - "applicationGroupReferences": { - "readOnly": true, - "type": "array", - "description": "List of applicationGroup links.", - "items": { - "type": "string" - } - }, - "ssoContext": { - "type": "string", - "description": "Path to keyvault containing ssoContext secret." - }, - "preferredAppGroupType": { - "enum": [ - "None", - "Desktop", - "RailApplications" - ], - "x-ms-enum": { - "name": "PreferredAppGroupType", - "modelAsString": true - }, - "type": "string", - "description": "The type of preferred application group type, default to Desktop Application Group", - "x-nullable": false - } - } - }, - "HostPoolPatch": { - "type": "object", - "description": "HostPool properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "HostPool properties that can be patched.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HostPoolPatchProperties" - } - } - }, - "HostPoolPatchProperties": { - "description": "Properties of HostPool.", - "type": "object", - "properties": { - "friendlyName": { - "type": "string", - "description": "Friendly name of HostPool." - }, - "description": { - "type": "string", - "description": "Description of HostPool." - }, - "customRdpProperty": { - "type": "string", - "description": "Custom rdp property of HostPool." - }, - "maxSessionLimit": { - "type": "integer", - "description": "The max session limit of HostPool." - }, - "personalDesktopAssignmentType": { - "enum": [ - "Automatic", - "Direct" - ], - "x-ms-enum": { - "name": "PersonalDesktopAssignmentType", - "modelAsString": true - }, - "type": "string", - "description": "PersonalDesktopAssignment type for HostPool." - }, - "loadBalancerType": { - "enum": [ - "BreadthFirst", - "DepthFirst", - "Persistent" - ], - "x-ms-enum": { - "name": "LoadBalancerType", - "modelAsString": true - }, - "type": "string", - "description": "The type of the load balancer." - }, - "ring": { - "type": "integer", - "description": "The ring number of HostPool." - }, - "validationEnvironment": { - "type": "boolean", - "description": "Is validation environment." - }, - "registrationInfo": { - "$ref": "#/definitions/RegistrationInfoPatch", - "description": "The registration info of HostPool." - }, - "ssoContext": { - "type": "string", - "description": "Path to keyvault containing ssoContext secret." - }, - "preferredAppGroupType": { - "enum": [ - "None", - "Desktop", - "RailApplications" - ], - "x-ms-enum": { - "name": "PreferredAppGroupType", - "modelAsString": true - }, - "type": "string", - "description": "The type of preferred application group type, default to Desktop Application Group" - } - } - }, - "RegistrationInfo": { - "description": "Represents a RegistrationInfo definition.", - "type": "object", - "properties": { - "expirationTime": { - "format": "date-time", - "type": "string", - "description": "Expiration time of registration token." - }, - "token": { - "type": "string", - "description": "The registration token base64 encoded string." - }, - "resetToken": { - "type": "boolean", - "description": "Update registration token." - } - } - }, - "RegistrationInfoPatch": { - "description": "Represents a RegistrationInfo definition.", - "type": "object", - "properties": { - "resetToken": { - "type": "boolean", - "description": "Update registration token." - } - } - }, - "SendMessage": { - "description": "Represents message sent to a UserSession.", - "type": "object", - "properties": { - "messageTitle": { - "type": "string", - "description": "Title of message." - }, - "messageBody": { - "type": "string", - "description": "Body of message." - } - } - }, - "HostPoolList": { - "type": "object", - "title": "HostPoolList", - "description": "List of HostPool definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of HostPool definitions.", - "items": { - "$ref": "#/definitions/HostPool" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "Application": { - "description": "Schema for Application properties.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for Application", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationProperties" - } - } - }, - "ApplicationProperties": { - "description": "Schema for Application properties.", - "type": "object", - "required": [ - "commandLineSetting" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of Application." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Application." - }, - "filePath": { - "type": "string", - "description": "Specifies a path for the executable file for the application." - }, - "commandLineSetting": { - "enum": [ - "DoNotAllow", - "Allow", - "Require" - ], - "x-ms-enum": { - "name": "CommandLineSetting", - "modelAsString": true - }, - "type": "string", - "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", - "x-nullable": false - }, - "commandLineArguments": { - "type": "string", - "description": "Command Line Arguments for Application." - }, - "showInPortal": { - "type": "boolean", - "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." - }, - "iconPath": { - "type": "string", - "description": "Path to icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - }, - "iconHash": { - "readOnly": true, - "type": "string", - "description": "Hash of the icon." - }, - "iconContent": { - "readOnly": true, - "type": "string", - "format": "byte", - "description": "the icon a 64 bit string as a byte array." - } - } - }, - "ApplicationList": { - "type": "object", - "title": "ApplicationList", - "description": "List of Application definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Application definitions.", - "items": { - "$ref": "#/definitions/Application" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "ApplicationPatch": { - "type": "object", - "description": "Application properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Application", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationPatchProperties" - } - } - }, - "ApplicationPatchProperties": { - "description": "Application properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Application." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Application." - }, - "filePath": { - "type": "string", - "description": "Specifies a path for the executable file for the application." - }, - "commandLineSetting": { - "enum": [ - "DoNotAllow", - "Allow", - "Require" - ], - "x-ms-enum": { - "name": "CommandLineSetting", - "modelAsString": true - }, - "type": "string", - "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." - }, - "commandLineArguments": { - "type": "string", - "description": "Command Line Arguments for Application." - }, - "showInPortal": { - "type": "boolean", - "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." - }, - "iconPath": { - "type": "string", - "description": "Path to icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - } - } - }, - "Desktop": { - "description": "Schema for Desktop properties.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for Desktop", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DesktopProperties" - } - } - }, - "DesktopProperties": { - "description": "Schema for Desktop properties.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Desktop." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Desktop." - }, - "iconHash": { - "readOnly": true, - "type": "string", - "description": "Hash of the icon." - }, - "iconContent": { - "readOnly": true, - "type": "string", - "format": "byte", - "description": "The icon a 64 bit string as a byte array." - } - } - }, - "DesktopList": { - "type": "object", - "title": "DesktopList", - "description": "List of Desktop definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Desktop definitions.", - "items": { - "$ref": "#/definitions/Desktop" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "DesktopPatch": { - "type": "object", - "description": "Desktop properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Desktop", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DesktopPatchProperties" - } - } - }, - "DesktopPatchProperties": { - "description": "Desktop properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Desktop." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Desktop." - } - } - }, - "StartMenuItemProperties": { - "description": "Schema for StartMenuItem properties.", - "type": "object", - "properties": { - "appAlias": { - "type": "string", - "description": "Alias of StartMenuItem." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of StartMenuItem." - }, - "filePath": { - "type": "string", - "description": "Path to the file of StartMenuItem." - }, - "commandLineArguments": { - "type": "string", - "description": "Command line arguments for StartMenuItem." - }, - "iconPath": { - "type": "string", - "description": "Path to the icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - } - } - }, - "StartMenuItem": { - "type": "object", - "description": "Represents a StartMenuItem definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for StartMenuItem", - "x-ms-client-flatten": true, - "$ref": "#/definitions/StartMenuItemProperties" - } - } - }, - "StartMenuItemList": { - "type": "object", - "title": "StartMenuItemList", - "description": "List of StartMenuItem definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of StartMenuItem definitions.", - "items": { - "$ref": "#/definitions/StartMenuItem" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "SessionHost": { - "type": "object", - "description": "Represents a SessionHost definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for SessionHost", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SessionHostProperties" - } - } - }, - "SessionHostProperties": { - "description": "Schema for SessionHost properties.", - "type": "object", - "properties": { - "lastHeartBeat": { - "format": "date-time", - "type": "string", - "description": "Last heart beat from SessionHost." - }, - "sessions": { - "type": "integer", - "description": "Number of sessions on SessionHost." - }, - "agentVersion": { - "type": "string", - "description": "Version of agent on SessionHost." - }, - "allowNewSession": { - "type": "boolean", - "description": "Allow a new session." - }, - "virtualMachineId": { - "type": "string", - "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", - "readOnly": true - }, - "resourceId": { - "type": "string", - "description": "Resource Id of SessionHost's underlying virtual machine.", - "readOnly": true - }, - "assignedUser": { - "type": "string", - "description": "User assigned to SessionHost." - }, - "status": { - "enum": [ - "Available", - "Unavailable", - "Shutdown", - "Disconnected", - "Upgrading", - "UpgradeFailed" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - }, - "type": "string", - "description": "Status for a SessionHost." - }, - "statusTimestamp": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the status.", - "readOnly": true - }, - "osVersion": { - "type": "string", - "description": "The version of the OS on the session host." - }, - "sxSStackVersion": { - "type": "string", - "description": "The version of the side by side stack on the session host." - }, - "updateState": { - "enum": [ - "Initial", - "Pending", - "Started", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "UpdateState", - "modelAsString": true - }, - "type": "string", - "description": "Update state of a SessionHost." - }, - "lastUpdateTime": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the last update.", - "readOnly": true - }, - "updateErrorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "SessionHostPatch": { - "type": "object", - "description": "SessionHost properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for SessionHost", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SessionHostPatchProperties" - } - } - }, - "SessionHostPatchProperties": { - "description": "SessionHost properties that can be patched.", - "type": "object", - "properties": { - "allowNewSession": { - "type": "boolean", - "description": "Allow a new session." - }, - "assignedUser": { - "type": "string", - "description": "User assigned to SessionHost." - } - } - }, - "SessionHostList": { - "type": "object", - "title": "SessionHostList", - "description": "List of SessionHost definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of SessionHost definitions.", - "items": { - "$ref": "#/definitions/SessionHost" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "UserSession": { - "type": "object", - "description": "Represents a UserSession definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for UserSession", - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserSessionProperties" - } - } - }, - "UserSessionProperties": { - "description": "Schema for UserSession properties.", - "type": "object", - "properties": { - "userPrincipalName": { - "type": "string", - "description": "The user principal name." - }, - "applicationType": { - "enum": [ - "RemoteApp", - "Desktop" - ], - "x-ms-enum": { - "name": "ApplicationType", - "modelAsString": true - }, - "type": "string", - "description": "Application type of application." - }, - "sessionState": { - "enum": [ - "Unknown", - "Active", - "Disconnected", - "Pending", - "LogOff", - "UserProfileDiskMounted" - ], - "x-ms-enum": { - "name": "SessionState", - "modelAsString": true - }, - "type": "string", - "description": "State of user session." - }, - "activeDirectoryUserName": { - "type": "string", - "description": "The active directory user name." - }, - "createTime": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the user session create." - } - } - }, - "UserSessionList": { - "type": "object", - "title": "UserSessionList", - "description": "List of UserSession definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of UserSession definitions.", - "items": { - "$ref": "#/definitions/UserSession" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - } - }, - "parameters": { - "HostPoolNameParameter": { - "name": "hostPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the host pool within the specified resource group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "ApplicationGroupNameParameter": { - "name": "applicationGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the application group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "ApplicationNameParameter": { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the application within the specified application group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "DesktopNameParameter": { - "name": "desktopName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the desktop within the specified desktop group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "WorkspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the workspace", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "SessionHostNameParameter": { - "name": "sessionHostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the session host within the specified host pool", - "maxLength": 48, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "UserSessionIdParameter": { - "name": "userSessionId", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the user session within the specified session host", - "maxLength": 24, - "minLength": 1, - "x-ms-parameter-location": "method" - }, - "StartMenuItemNameParameter": { - "name": "startMenuItemName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the start menu item within the specified host pool", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "version": "2019-01-23-preview", + "title": "Desktop Virtualization API Client" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List all of the available operations the Desktop Virtualization resource provider supports.", + "x-ms-examples": { + "OperationDescription_List": { + "$ref": "./examples/OperationDescription_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Get a workspace.", + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspace_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Successfully created workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Remove a workspace.", + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspace_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted workspace." + }, + "204": { + "description": "Workspace does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Update a workspace.", + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspace_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "List workspaces.", + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspace_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "List workspaces in subscription.", + "x-ms-examples": { + "Workspace_ListBySubscription": { + "$ref": "./examples/Workspace_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Get", + "description": "Get an application group.", + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroup_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_CreateOrUpdate", + "description": "Create or update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroup_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Successfully created application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Delete", + "description": "Remove an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Delete": { + "$ref": "./examples/ApplicationGroup_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application group." + }, + "204": { + "description": "Application group does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Update", + "description": "Update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroups_Update": { + "$ref": "./examples/ApplicationGroup_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListByResourceGroup", + "description": "List applicationGroups.", + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in resource group.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListBySubscription", + "description": "List applicationGroups in subscription.", + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroup_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in subscription.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "tags": [ + "StartMenuItem" + ], + "operationId": "StartMenuItems_List", + "description": "List start menu items in the given application group.", + "x-ms-examples": { + "StartMenuItem_List": { + "$ref": "./examples/StartMenuItem_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved start menu items in application group.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "description": "Get an application.", + "x-ms-examples": { + "Application_Get": { + "$ref": "./examples/Application_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Create or update an application.", + "x-ms-examples": { + "Application_Create": { + "$ref": "./examples/Application_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Successfully created application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "description": "Remove an application.", + "x-ms-examples": { + "Application_Delete": { + "$ref": "./examples/Application_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application." + }, + "204": { + "description": "Application does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "description": "Update an application.", + "x-ms-examples": { + "Application_Update": { + "$ref": "./examples/Application_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "description": "List applications.", + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Application_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved applications in application group.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Get", + "description": "Get a desktop.", + "x-ms-examples": { + "Desktop_Get": { + "$ref": "./examples/Desktop_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Update", + "description": "Update a desktop.", + "x-ms-examples": { + "Desktop_Update": { + "$ref": "./examples/Desktop_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + }, + { + "name": "desktop", + "description": "Object containing Desktop definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_List", + "description": "List desktops.", + "x-ms-examples": { + "Desktop_List": { + "$ref": "./examples/Desktop_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktops in application group.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Get", + "description": "Get a host pool.", + "x-ms-examples": { + "HostPool_Get": { + "$ref": "./examples/HostPool_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_CreateOrUpdate", + "description": "Create or update a host pool.", + "x-ms-examples": { + "HostPool_Create": { + "$ref": "./examples/HostPool_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Successfully created host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Delete", + "description": "Remove a host pool.", + "x-ms-examples": { + "HostPool_Delete": { + "$ref": "./examples/HostPool_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete sessionHost." + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool." + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Update", + "description": "Update a host pool.", + "x-ms-examples": { + "HostPool_Update": { + "$ref": "./examples/HostPool_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListByResourceGroup", + "description": "List hostPools.", + "x-ms-examples": { + "HostPool_ListByResourceGroup": { + "$ref": "./examples/HostPool_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_List", + "description": "List hostPools in subscription.", + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in subscription.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_ListByHostPool", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSession_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in host pool.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Get", + "description": "Get a session host.", + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHost_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Delete", + "description": "Remove a SessionHost.", + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHost_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to force sessionHost deletion even when userSession exists." + } + ], + "responses": { + "200": { + "description": "Successfully removed session host." + }, + "204": { + "description": "Session host does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Update", + "description": "Update a session host.", + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHost_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_List", + "description": "List sessionHosts.", + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHost_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session hosts in host pool.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Get", + "description": "Get a userSession.", + "x-ms-examples": { + "UserSession_Get": { + "$ref": "./examples/UserSession_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user session.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Delete", + "description": "Remove a userSession.", + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSession_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to login off userSession." + } + ], + "responses": { + "200": { + "description": "Successfully removed user session." + }, + "204": { + "description": "User session does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_List", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSession_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in session host.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Disconnect", + "description": "Disconnect a userSession.", + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSession_Disconnect_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disconnected user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_SendMessage", + "description": "Send a message to a user.", + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSession_SendMessage_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "sendMessage", + "description": "Object containing message includes title and message body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "Successfully sent message to user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error response of an operation failure" + }, + "ResourceProviderOperationList": { + "description": "Result of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + } + } + }, + "ResourceProviderOperation": { + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Desktop Virtualization.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + } + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceProperties": { + "description": "Schema for Workspace properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkspaceList": { + "type": "object", + "title": "WorkspaceList", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Workspace definitions.", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspacePatchProperties" + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupProperties" + } + } + }, + "ApplicationGroupProperties": { + "description": "Schema for ApplicationGroup properties.", + "type": "object", + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup.", + "x-nullable": false + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "x-nullable": false + } + } + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "ApplicationGroup properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupPatchProperties" + } + } + }, + "ApplicationGroupPatchProperties": { + "description": "ApplicationGroup properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + } + } + }, + "ApplicationGroupList": { + "type": "object", + "title": "ApplicationGroupList", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ApplicationGroup definitions.", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolProperties" + } + } + }, + "HostPoolProperties": { + "description": "Properties of HostPool.", + "type": "object", + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ], + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true + }, + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": false + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer.", + "x-nullable": false + }, + "ring": { + "type": "integer", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "ssoContext": { + "type": "string", + "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false + } + } + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "HostPool properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolPatchProperties" + } + } + }, + "HostPoolPatchProperties": { + "description": "Properties of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "ssoContext": { + "type": "string", + "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" + } + } + }, + "RegistrationInfo": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "resetToken": { + "type": "boolean", + "description": "Update registration token." + } + } + }, + "RegistrationInfoPatch": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "resetToken": { + "type": "boolean", + "description": "Update registration token." + } + } + }, + "SendMessage": { + "description": "Represents message sent to a UserSession.", + "type": "object", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "HostPoolList": { + "type": "object", + "title": "HostPoolList", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPool definitions.", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties" + } + } + }, + "ApplicationProperties": { + "description": "Schema for Application properties.", + "type": "object", + "required": [ + "commandLineSetting" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "x-nullable": false + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "ApplicationList": { + "type": "object", + "title": "ApplicationList", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Application definitions.", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPatchProperties" + } + } + }, + "ApplicationPatchProperties": { + "description": "Application properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + } + } + }, + "Desktop": { + "description": "Schema for Desktop properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopProperties" + } + } + }, + "DesktopProperties": { + "description": "Schema for Desktop properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array." + } + } + }, + "DesktopList": { + "type": "object", + "title": "DesktopList", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Desktop definitions.", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopPatchProperties" + } + } + }, + "DesktopPatchProperties": { + "description": "Desktop properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "StartMenuItemProperties": { + "description": "Schema for StartMenuItem properties.", + "type": "object", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + } + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for StartMenuItem", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StartMenuItemProperties" + } + } + }, + "StartMenuItemList": { + "type": "object", + "title": "StartMenuItemList", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of StartMenuItem definitions.", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostProperties" + } + } + }, + "SessionHostProperties": { + "description": "Schema for SessionHost properties.", + "type": "object", + "properties": { + "lastHeartBeat": { + "format": "date-time", + "type": "string", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "status": { + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "type": "string", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true + }, + "type": "string", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostPatchProperties" + } + } + }, + "SessionHostPatchProperties": { + "description": "SessionHost properties that can be patched.", + "type": "object", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + } + } + }, + "SessionHostList": { + "type": "object", + "title": "SessionHostList", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHost definitions.", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserSessionProperties" + } + } + }, + "UserSessionProperties": { + "description": "Schema for UserSession properties.", + "type": "object", + "properties": { + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Application type of application." + }, + "sessionState": { + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true + }, + "type": "string", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the user session create." + } + } + }, + "UserSessionList": { + "type": "object", + "title": "UserSessionList", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UserSession definitions.", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + } + }, + "parameters": { + "HostPoolNameParameter": { + "name": "hostPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the host pool within the specified resource group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationGroupNameParameter": { + "name": "applicationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application within the specified application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DesktopNameParameter": { + "name": "desktopName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the desktop within the specified desktop group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "SessionHostNameParameter": { + "name": "sessionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the session host within the specified host pool", + "maxLength": 48, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "UserSessionIdParameter": { + "name": "userSessionId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user session within the specified session host", + "maxLength": 24, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "StartMenuItemNameParameter": { + "name": "startMenuItemName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the start menu item within the specified host pool", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Create.json index c75ce77be78f..c2a48ba9c91e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Create.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-01-23-preview", - "applicationGroup": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "applicationGroupType": "RemoteApp" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - }, - "201": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-01-23-preview", + "applicationGroup": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType": "RemoteApp" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Delete.json index ae2bbf71e8cc..ee690a2278b8 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Delete.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Get.json index 56dcd59e08c8..6ffbe1b4b5ac 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Get.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Update.json index 2f206a5f4560..905698121283 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroup_Update.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-01-23-preview", - "applicationGroup": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-01-23-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Create.json index 684a81bf75f9..dc8630a7f5a0 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Create.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-01-23-preview", - "application": { - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1 - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - }, - "201": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-01-23-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Delete.json index eb471d6e7f5c..b5a795cabaa5 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Delete.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Get.json index 3cb0ca998e75..49ef6a81fe95 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Get.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_List.json index a49c11d5a7d5..d8a94e86d8bb 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_List.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - { - "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des2", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Update.json index 0c7295dc9509..609af3bac5c6 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Application_Update.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-01-23-preview", - "application": { - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1 - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-01-23-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json index 3c08b9ce934b..eda470b690aa 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json @@ -1,92 +1,92 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-01-23-preview", - "hostPool": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "resetToken": true - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "resetToken": true - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - }, - "201": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "resetToken": true - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-01-23-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "resetToken": true + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "resetToken": true + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "resetToken": true + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Delete.json index 4a35ba990066..2f87e3ccccd0 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Delete.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-01-23-preview", - "force": true - }, - "responses": { - "200": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "resetToken": false - }, - "ssoContext": "KeyVaultPath" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-01-23-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "resetToken": false + }, + "ssoContext": "KeyVaultPath" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json index d286a94ffd5c..747db33f003b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "resetToken": false - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "resetToken": false + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json index 6593f5e1cb0a..78e8cfee86d8 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-01-23-preview", - "hostPool": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "personalDesktopAssignmentType": "Automatic", - "registrationInfo": { - "resetToken": false - }, - "ssoContext": "KeyVaultPath" - } - } - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "resetToken": false - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-01-23-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "resetToken": false + }, + "ssoContext": "KeyVaultPath" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "resetToken": false + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/OperationDescription_List.json index f8b4fa7714f1..9174464d93fd 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/OperationDescription_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/OperationDescription_List.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DesktopVirtualization/ssocontext/read", - "display": { - "provider": "Microsoft.DesktopVirtualization", - "resource": "ssocontext" - } - }, - { - "name": "Microsoft.DesktopVirtualization/ssocontext/write", - "display": { - "provider": "Microsoft.DesktopVirtualization", - "resource": "ssocontext" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/ssocontext/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "ssocontext" + } + }, + { + "name": "Microsoft.DesktopVirtualization/ssocontext/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "ssocontext" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json index a0fb8de17874..b868173cd059 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-01-23-preview", - "force": true - }, - "responses": { - "200": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-01-23-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json index cdf7f8c1d3a2..6e43a591e215 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json index 4dffe5b95b7f..635b9aba7306 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - }, - { - "name": "sessionHost2.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user2@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json index fa38d983465f..a2a74041518f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-01-23-preview", - "sessionHost": { - "properties": { - "allowNewSession": true, - "assignedUser": "user1@microsoft.com" - } - } - }, - "responses": { - "200": { - "body": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2019-01-24T20:00:08.2893033Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-01-23-preview", + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/StartMenuItem_List.json index 6adb97a59168..18fa1240189c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/StartMenuItem_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/StartMenuItem_List.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", - "properties": { - "appAlias": "word", - "friendlyName": "friendly", - "filePath": "/path/to/file", - "commandLineArguments": "arguments", - "iconPath": "/path/to/icon", - "iconIndex": 1 - } - }, - { - "name": "application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", - "properties": { - "appAlias": "excel", - "friendlyName": "friendly", - "filePath": "/path/to/file", - "commandLineArguments": "arguments", - "iconPath": "/path/to/icon", - "iconIndex": 1 - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "friendlyName": "friendly", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "friendlyName": "friendly", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Delete.json index 9e3f7954e56d..bb69d8e0e1bf 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Delete.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-01-23-preview", - "force": true - }, - "responses": { - "200": { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-01-23-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Disconnect_Post.json index 6e3eda65d3a9..188c24cfb329 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Disconnect_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Disconnect_Post.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Get.json index 920cecc824a5..f978027d9a2d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_SendMessage_Post.json index e9b9ea50e324..37c844447527 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_SendMessage_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/UserSession_SendMessage_Post.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-01-23-preview", - "sendMessage": { - "messageTitle": "title", - "messageBody": "body" - } - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-01-23-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Create.json index 136ed75d9cca..bdae0db548ce 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Create.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-01-23-preview", - "workspace": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "201": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-01-23-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Delete.json index 913ef919c812..c1183229eb2b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Delete.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Get.json index 691cbf19aa88..9bd78168a76d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-01-23-preview" - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-01-23-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Update.json index 7398e946deab..0f3c21cbd975 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/Workspace_Update.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-01-23-preview", - "workspace": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-01-23-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json index bfa107e11949..a1eed968b60c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json @@ -1,3005 +1,3005 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-09-24-preview", - "title": "Desktop Virtualization API Client" - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "host": "management.azure.com", - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.DesktopVirtualization/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "List all of the available operations the Desktop Virtualization resource provider supports.", - "x-ms-examples": { - "OperationDescription_List": { - "$ref": "./examples/OperationDescription_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved operations.", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationList" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Get", - "description": "Get a workspace.", - "x-ms-examples": { - "Workspace_Get": { - "$ref": "./examples/Workspace_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_CreateOrUpdate", - "description": "Create or update a workspace.", - "x-ms-examples": { - "Workspace_Create": { - "$ref": "./examples/Workspace_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspace", - "description": "Object containing Workspace definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "201": { - "description": "Successfully created workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Delete", - "description": "Remove a workspace.", - "x-ms-examples": { - "Workspace_Delete": { - "$ref": "./examples/Workspace_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted workspace." - }, - "204": { - "description": "Workspace does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Update", - "description": "Update a workspace.", - "x-ms-examples": { - "Workspace_Update": { - "$ref": "./examples/Workspace_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspace", - "description": "Object containing Workspace definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/WorkspacePatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListByResourceGroup", - "description": "List workspaces.", - "x-ms-examples": { - "Workspace_ListByResourceGroup": { - "$ref": "./examples/Workspace_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspaces in resource group.", - "schema": { - "$ref": "#/definitions/WorkspaceList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListBySubscription", - "description": "List workspaces in subscription.", - "x-ms-examples": { - "Workspace_ListBySubscription": { - "$ref": "./examples/Workspace_ListBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspaces in subscription.", - "schema": { - "$ref": "#/definitions/WorkspaceList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Get", - "description": "Get an application group.", - "x-ms-examples": { - "ApplicationGroup_Get": { - "$ref": "./examples/ApplicationGroup_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_CreateOrUpdate", - "description": "Create or update an applicationGroup.", - "x-ms-examples": { - "ApplicationGroup_Create": { - "$ref": "./examples/ApplicationGroup_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "applicationGroup", - "description": "Object containing ApplicationGroup definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "201": { - "description": "Successfully created application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Delete", - "description": "Remove an applicationGroup.", - "x-ms-examples": { - "ApplicationGroup_Delete": { - "$ref": "./examples/ApplicationGroup_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully removed application group." - }, - "204": { - "description": "Application group does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Update", - "description": "Update an applicationGroup.", - "x-ms-examples": { - "ApplicationGroups_Update": { - "$ref": "./examples/ApplicationGroup_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "applicationGroup", - "description": "Object containing ApplicationGroup definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApplicationGroupPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_ListByResourceGroup", - "description": "List applicationGroups.", - "x-ms-examples": { - "ApplicationGroup_ListByResourceGroup": { - "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application groups in resource group.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_ListBySubscription", - "description": "List applicationGroups in subscription.", - "x-ms-examples": { - "ApplicationGroup_List": { - "$ref": "./examples/ApplicationGroup_ListBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application groups in subscription.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { - "get": { - "tags": [ - "StartMenuItem" - ], - "operationId": "StartMenuItems_List", - "description": "List start menu items in the given application group.", - "x-ms-examples": { - "StartMenuItem_List": { - "$ref": "./examples/StartMenuItem_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved start menu items in application group.", - "schema": { - "$ref": "#/definitions/StartMenuItemList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_Get", - "description": "Get an application.", - "x-ms-examples": { - "Application_Get": { - "$ref": "./examples/Application_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "Application" - ], - "operationId": "Applications_CreateOrUpdate", - "description": "Create or update an application.", - "x-ms-examples": { - "Application_Create": { - "$ref": "./examples/Application_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "name": "application", - "description": "Object containing Application definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Application" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "201": { - "description": "Successfully created application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Application" - ], - "operationId": "Applications_Delete", - "description": "Remove an application.", - "x-ms-examples": { - "Application_Delete": { - "$ref": "./examples/Application_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully removed application." - }, - "204": { - "description": "Application does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Application" - ], - "operationId": "Applications_Update", - "description": "Update an application.", - "x-ms-examples": { - "Application_Update": { - "$ref": "./examples/Application_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "name": "application", - "description": "Object containing Application definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApplicationPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_List", - "description": "List applications.", - "x-ms-examples": { - "Applications_List": { - "$ref": "./examples/Application_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved applications in application group.", - "schema": { - "$ref": "#/definitions/ApplicationList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { - "get": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_Get", - "description": "Get a desktop.", - "x-ms-examples": { - "Desktop_Get": { - "$ref": "./examples/Desktop_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/DesktopNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved desktop.", - "schema": { - "$ref": "#/definitions/Desktop" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_Update", - "description": "Update a desktop.", - "x-ms-examples": { - "Desktop_Update": { - "$ref": "./examples/Desktop_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/DesktopNameParameter" - }, - { - "name": "desktop", - "description": "Object containing Desktop definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DesktopPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated desktop.", - "schema": { - "$ref": "#/definitions/Desktop" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { - "get": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_List", - "description": "List desktops.", - "x-ms-examples": { - "Desktop_List": { - "$ref": "./examples/Desktop_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved desktops in application group.", - "schema": { - "$ref": "#/definitions/DesktopList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Get", - "description": "Get a host pool.", - "x-ms-examples": { - "HostPool_Get": { - "$ref": "./examples/HostPool_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_CreateOrUpdate", - "description": "Create or update a host pool.", - "x-ms-examples": { - "HostPool_Create": { - "$ref": "./examples/HostPool_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "hostPool", - "description": "Object containing HostPool definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HostPool" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "201": { - "description": "Successfully created host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Delete", - "description": "Remove a host pool.", - "x-ms-examples": { - "HostPool_Delete": { - "$ref": "./examples/HostPool_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to delete sessionHost." - } - ], - "responses": { - "200": { - "description": "Successfully removed host pool." - }, - "204": { - "description": "Host pool does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Update", - "description": "Update a host pool.", - "x-ms-examples": { - "HostPool_Update": { - "$ref": "./examples/HostPool_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "hostPool", - "description": "Object containing HostPool definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/HostPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_ListByResourceGroup", - "description": "List hostPools.", - "x-ms-examples": { - "HostPool_ListByResourceGroup": { - "$ref": "./examples/HostPool_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool in resource group.", - "schema": { - "$ref": "#/definitions/HostPoolList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_List", - "description": "List hostPools in subscription.", - "x-ms-examples": { - "HostPool_List": { - "$ref": "./examples/HostPool_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool in subscription.", - "schema": { - "$ref": "#/definitions/HostPoolList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_ListByHostPool", - "description": "List userSessions.", - "x-ms-examples": { - "UserSession_ListByHostPool": { - "$ref": "./examples/UserSession_ListByHostPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user sessions in host pool.", - "schema": { - "$ref": "#/definitions/UserSessionList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { - "get": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Get", - "description": "Get a session host.", - "x-ms-examples": { - "SessionHost_Get": { - "$ref": "./examples/SessionHost_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved session host.", - "schema": { - "$ref": "#/definitions/SessionHost" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Delete", - "description": "Remove a SessionHost.", - "x-ms-examples": { - "SessionHost_Delete": { - "$ref": "./examples/SessionHost_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to force sessionHost deletion even when userSession exists." - } - ], - "responses": { - "200": { - "description": "Successfully removed session host." - }, - "204": { - "description": "Session host does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Update", - "description": "Update a session host.", - "x-ms-examples": { - "SessionHost_Update": { - "$ref": "./examples/SessionHost_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "sessionHost", - "description": "Object containing SessionHost definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SessionHostPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated session host.", - "schema": { - "$ref": "#/definitions/SessionHost" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { - "get": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_List", - "description": "List sessionHosts.", - "x-ms-examples": { - "SessionHost_List": { - "$ref": "./examples/SessionHost_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved session hosts in host pool.", - "schema": { - "$ref": "#/definitions/SessionHostList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Get", - "description": "Get a userSession.", - "x-ms-examples": { - "UserSession_Get": { - "$ref": "./examples/UserSession_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user session.", - "schema": { - "$ref": "#/definitions/UserSession" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Delete", - "description": "Remove a userSession.", - "x-ms-examples": { - "UserSession_Delete": { - "$ref": "./examples/UserSession_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to login off userSession." - } - ], - "responses": { - "200": { - "description": "Successfully removed user session." - }, - "204": { - "description": "User session does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_List", - "description": "List userSessions.", - "x-ms-examples": { - "UserSession_List": { - "$ref": "./examples/UserSession_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user sessions in session host.", - "schema": { - "$ref": "#/definitions/UserSessionList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { - "post": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Disconnect", - "description": "Disconnect a userSession.", - "x-ms-examples": { - "UserSession_Disconnect_Post": { - "$ref": "./examples/UserSession_Disconnect_Post.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully disconnected user session." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { - "post": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_SendMessage", - "description": "Send a message to a user.", - "x-ms-examples": { - "UserSession_SendMessage_Post": { - "$ref": "./examples/UserSession_SendMessage_Post.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - }, - { - "name": "sendMessage", - "description": "Object containing message includes title and message body", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SendMessage" - } - } - ], - "responses": { - "200": { - "description": "Successfully sent message to user session." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "CloudError": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error response of an operation failure" - }, - "ResourceProviderOperationList": { - "description": "Result of the request to list operations.", - "readOnly": true, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperation" - }, - "description": "List of operations supported by this resource provider." - } - } - }, - "ResourceProviderOperation": { - "description": "Supported operation of this resource provider.", - "readOnly": true, - "properties": { - "name": { - "description": "Operation name, in format of {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Resource provider: Microsoft Desktop Virtualization.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "Type of operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of this operation.", - "type": "string" - } - } - } - } - }, - "Workspace": { - "type": "object", - "description": "Represents a Workspace definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for Workspace", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspaceProperties" - } - } - }, - "WorkspaceProperties": { - "description": "Schema for Workspace properties.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Workspace." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Workspace." - }, - "applicationGroupReferences": { - "type": "array", - "description": "List of applicationGroup resource Ids.", - "items": { - "type": "string" - } - } - } - }, - "WorkspaceList": { - "type": "object", - "title": "WorkspaceList", - "description": "List of Workspace definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Workspace definitions.", - "items": { - "$ref": "#/definitions/Workspace" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "WorkspacePatch": { - "type": "object", - "description": "Workspace properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Workspace", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspacePatchProperties" - } - } - }, - "WorkspacePatchProperties": { - "description": "Workspace properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Workspace." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Workspace." - }, - "applicationGroupReferences": { - "type": "array", - "description": "List of applicationGroup links.", - "items": { - "type": "string" - } - } - } - }, - "ApplicationGroup": { - "type": "object", - "description": "Represents a ApplicationGroup definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for ApplicationGroup", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGroupProperties" - } - } - }, - "ApplicationGroupProperties": { - "description": "Schema for ApplicationGroup properties.", - "type": "object", - "required": [ - "hostPoolArmPath", - "applicationGroupType" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of ApplicationGroup." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of ApplicationGroup." - }, - "hostPoolArmPath": { - "type": "string", - "description": "HostPool arm path of ApplicationGroup.", - "x-nullable": false - }, - "workspaceArmPath": { - "type": "string", - "description": "Workspace arm path of ApplicationGroup.", - "readOnly": true - }, - "applicationGroupType": { - "enum": [ - "RemoteApp", - "Desktop" - ], - "x-ms-enum": { - "name": "ApplicationGroupType", - "modelAsString": true - }, - "type": "string", - "description": "Resource Type of ApplicationGroup.", - "x-nullable": false - } - } - }, - "ApplicationGroupPatch": { - "type": "object", - "description": "ApplicationGroup properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "ApplicationGroup properties that can be patched.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGroupPatchProperties" - } - } - }, - "ApplicationGroupPatchProperties": { - "description": "ApplicationGroup properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of ApplicationGroup." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of ApplicationGroup." - } - } - }, - "ApplicationGroupList": { - "type": "object", - "title": "ApplicationGroupList", - "description": "List of ApplicationGroup definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of ApplicationGroup definitions.", - "items": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "HostPool": { - "type": "object", - "description": "Represents a HostPool definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for HostPool", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HostPoolProperties" - } - } - }, - "HostPoolProperties": { - "description": "Properties of HostPool.", - "type": "object", - "required": [ - "hostPoolType", - "loadBalancerType", - "preferredAppGroupType" - ], - "properties": { - "friendlyName": { - "type": "string", - "description": "Friendly name of HostPool." - }, - "description": { - "type": "string", - "description": "Description of HostPool." - }, - "hostPoolType": { - "enum": [ - "Personal", - "Shared" - ], - "x-ms-enum": { - "name": "HostPoolType", - "modelAsString": true - }, - "type": "string", - "description": "HostPool type for desktop.", - "x-nullable": false - }, - "personalDesktopAssignmentType": { - "enum": [ - "Automatic", - "Direct" - ], - "x-ms-enum": { - "name": "PersonalDesktopAssignmentType", - "modelAsString": true - }, - "type": "string", - "description": "PersonalDesktopAssignment type for HostPool.", - "x-nullable": false - }, - "customRdpProperty": { - "type": "string", - "description": "Custom rdp property of HostPool." - }, - "maxSessionLimit": { - "type": "integer", - "description": "The max session limit of HostPool." - }, - "loadBalancerType": { - "enum": [ - "BreadthFirst", - "DepthFirst", - "Persistent" - ], - "x-ms-enum": { - "name": "LoadBalancerType", - "modelAsString": true - }, - "type": "string", - "description": "The type of the load balancer.", - "x-nullable": false - }, - "ring": { - "type": "integer", - "description": "The ring number of HostPool." - }, - "validationEnvironment": { - "type": "boolean", - "description": "Is validation environment." - }, - "registrationInfo": { - "$ref": "#/definitions/RegistrationInfo", - "description": "The registration info of HostPool." - }, - "vmTemplate": { - "type": "string", - "description": "VM template for sessionhosts configuration within hostpool." - }, - "applicationGroupReferences": { - "readOnly": true, - "type": "array", - "description": "List of applicationGroup links.", - "items": { - "type": "string" - } - }, - "ssoContext": { - "type": "string", - "description": "Path to keyvault containing ssoContext secret." - }, - "preferredAppGroupType": { - "enum": [ - "None", - "Desktop", - "RailApplications" - ], - "x-ms-enum": { - "name": "PreferredAppGroupType", - "modelAsString": true - }, - "type": "string", - "description": "The type of preferred application group type, default to Desktop Application Group", - "x-nullable": false - } - } - }, - "HostPoolPatch": { - "type": "object", - "description": "HostPool properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "HostPool properties that can be patched.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HostPoolPatchProperties" - } - } - }, - "HostPoolPatchProperties": { - "description": "Properties of HostPool.", - "type": "object", - "properties": { - "friendlyName": { - "type": "string", - "description": "Friendly name of HostPool." - }, - "description": { - "type": "string", - "description": "Description of HostPool." - }, - "customRdpProperty": { - "type": "string", - "description": "Custom rdp property of HostPool." - }, - "maxSessionLimit": { - "type": "integer", - "description": "The max session limit of HostPool." - }, - "personalDesktopAssignmentType": { - "enum": [ - "Automatic", - "Direct" - ], - "x-ms-enum": { - "name": "PersonalDesktopAssignmentType", - "modelAsString": true - }, - "type": "string", - "description": "PersonalDesktopAssignment type for HostPool." - }, - "loadBalancerType": { - "enum": [ - "BreadthFirst", - "DepthFirst", - "Persistent" - ], - "x-ms-enum": { - "name": "LoadBalancerType", - "modelAsString": true - }, - "type": "string", - "description": "The type of the load balancer." - }, - "ring": { - "type": "integer", - "description": "The ring number of HostPool." - }, - "validationEnvironment": { - "type": "boolean", - "description": "Is validation environment." - }, - "registrationInfo": { - "$ref": "#/definitions/RegistrationInfoPatch", - "description": "The registration info of HostPool." - }, - "ssoContext": { - "type": "string", - "description": "Path to keyvault containing ssoContext secret." - }, - "preferredAppGroupType": { - "enum": [ - "None", - "Desktop", - "RailApplications" - ], - "x-ms-enum": { - "name": "PreferredAppGroupType", - "modelAsString": true - }, - "type": "string", - "description": "The type of preferred application group type, default to Desktop Application Group" - } - } - }, - "RegistrationInfo": { - "description": "Represents a RegistrationInfo definition.", - "type": "object", - "properties": { - "expirationTime": { - "format": "date-time", - "type": "string", - "description": "Expiration time of registration token." - }, - "token": { - "type": "string", - "description": "The registration token base64 encoded string." - }, - "registrationTokenOperation": { - "enum": [ - "Delete", - "None", - "Update" - ], - "x-ms-enum": { - "name": "RegistrationTokenOperation", - "modelAsString": true - }, - "type": "string", - "description": "The type of resetting the token.", - "x-nullable": false - } - } - }, - "RegistrationInfoPatch": { - "description": "Represents a RegistrationInfo definition.", - "type": "object", - "properties": { - "registrationTokenOperation": { - "enum": [ - "Delete", - "None", - "Update" - ], - "x-ms-enum": { - "name": "RegistrationTokenOperation", - "modelAsString": true - }, - "type": "string", - "description": "The type of resetting the token." - } - } - }, - "SendMessage": { - "description": "Represents message sent to a UserSession.", - "type": "object", - "properties": { - "messageTitle": { - "type": "string", - "description": "Title of message." - }, - "messageBody": { - "type": "string", - "description": "Body of message." - } - } - }, - "HostPoolList": { - "type": "object", - "title": "HostPoolList", - "description": "List of HostPool definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of HostPool definitions.", - "items": { - "$ref": "#/definitions/HostPool" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "Application": { - "description": "Schema for Application properties.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for Application", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationProperties" - } - } - }, - "ApplicationProperties": { - "description": "Schema for Application properties.", - "type": "object", - "required": [ - "commandLineSetting" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of Application." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Application." - }, - "filePath": { - "type": "string", - "description": "Specifies a path for the executable file for the application." - }, - "commandLineSetting": { - "enum": [ - "DoNotAllow", - "Allow", - "Require" - ], - "x-ms-enum": { - "name": "CommandLineSetting", - "modelAsString": true - }, - "type": "string", - "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", - "x-nullable": false - }, - "commandLineArguments": { - "type": "string", - "description": "Command Line Arguments for Application." - }, - "showInPortal": { - "type": "boolean", - "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." - }, - "iconPath": { - "type": "string", - "description": "Path to icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - }, - "iconHash": { - "readOnly": true, - "type": "string", - "description": "Hash of the icon." - }, - "iconContent": { - "readOnly": true, - "type": "string", - "format": "byte", - "description": "the icon a 64 bit string as a byte array." - } - } - }, - "ApplicationList": { - "type": "object", - "title": "ApplicationList", - "description": "List of Application definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Application definitions.", - "items": { - "$ref": "#/definitions/Application" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "ApplicationPatch": { - "type": "object", - "description": "Application properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Application", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationPatchProperties" - } - } - }, - "ApplicationPatchProperties": { - "description": "Application properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Application." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Application." - }, - "filePath": { - "type": "string", - "description": "Specifies a path for the executable file for the application." - }, - "commandLineSetting": { - "enum": [ - "DoNotAllow", - "Allow", - "Require" - ], - "x-ms-enum": { - "name": "CommandLineSetting", - "modelAsString": true - }, - "type": "string", - "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." - }, - "commandLineArguments": { - "type": "string", - "description": "Command Line Arguments for Application." - }, - "showInPortal": { - "type": "boolean", - "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." - }, - "iconPath": { - "type": "string", - "description": "Path to icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - } - } - }, - "Desktop": { - "description": "Schema for Desktop properties.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for Desktop", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DesktopProperties" - } - } - }, - "DesktopProperties": { - "description": "Schema for Desktop properties.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Desktop." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Desktop." - }, - "iconHash": { - "readOnly": true, - "type": "string", - "description": "Hash of the icon." - }, - "iconContent": { - "readOnly": true, - "type": "string", - "format": "byte", - "description": "The icon a 64 bit string as a byte array." - } - } - }, - "DesktopList": { - "type": "object", - "title": "DesktopList", - "description": "List of Desktop definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Desktop definitions.", - "items": { - "$ref": "#/definitions/Desktop" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "DesktopPatch": { - "type": "object", - "description": "Desktop properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Desktop", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DesktopPatchProperties" - } - } - }, - "DesktopPatchProperties": { - "description": "Desktop properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Desktop." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Desktop." - } - } - }, - "StartMenuItemProperties": { - "description": "Schema for StartMenuItem properties.", - "type": "object", - "properties": { - "appAlias": { - "type": "string", - "description": "Alias of StartMenuItem." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of StartMenuItem." - }, - "filePath": { - "type": "string", - "description": "Path to the file of StartMenuItem." - }, - "commandLineArguments": { - "type": "string", - "description": "Command line arguments for StartMenuItem." - }, - "iconPath": { - "type": "string", - "description": "Path to the icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - } - } - }, - "StartMenuItem": { - "type": "object", - "description": "Represents a StartMenuItem definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for StartMenuItem", - "x-ms-client-flatten": true, - "$ref": "#/definitions/StartMenuItemProperties" - } - } - }, - "StartMenuItemList": { - "type": "object", - "title": "StartMenuItemList", - "description": "List of StartMenuItem definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of StartMenuItem definitions.", - "items": { - "$ref": "#/definitions/StartMenuItem" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "SessionHost": { - "type": "object", - "description": "Represents a SessionHost definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for SessionHost", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SessionHostProperties" - } - } - }, - "SessionHostProperties": { - "description": "Schema for SessionHost properties.", - "type": "object", - "properties": { - "lastHeartBeat": { - "format": "date-time", - "type": "string", - "description": "Last heart beat from SessionHost." - }, - "sessions": { - "type": "integer", - "description": "Number of sessions on SessionHost." - }, - "agentVersion": { - "type": "string", - "description": "Version of agent on SessionHost." - }, - "allowNewSession": { - "type": "boolean", - "description": "Allow a new session." - }, - "virtualMachineId": { - "type": "string", - "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", - "readOnly": true - }, - "resourceId": { - "type": "string", - "description": "Resource Id of SessionHost's underlying virtual machine.", - "readOnly": true - }, - "assignedUser": { - "type": "string", - "description": "User assigned to SessionHost." - }, - "status": { - "enum": [ - "Available", - "Unavailable", - "Shutdown", - "Disconnected", - "Upgrading", - "UpgradeFailed" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - }, - "type": "string", - "description": "Status for a SessionHost." - }, - "statusTimestamp": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the status.", - "readOnly": true - }, - "osVersion": { - "type": "string", - "description": "The version of the OS on the session host." - }, - "sxSStackVersion": { - "type": "string", - "description": "The version of the side by side stack on the session host." - }, - "updateState": { - "enum": [ - "Initial", - "Pending", - "Started", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "UpdateState", - "modelAsString": true - }, - "type": "string", - "description": "Update state of a SessionHost." - }, - "lastUpdateTime": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the last update.", - "readOnly": true - }, - "updateErrorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "SessionHostPatch": { - "type": "object", - "description": "SessionHost properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for SessionHost", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SessionHostPatchProperties" - } - } - }, - "SessionHostPatchProperties": { - "description": "SessionHost properties that can be patched.", - "type": "object", - "properties": { - "allowNewSession": { - "type": "boolean", - "description": "Allow a new session." - }, - "assignedUser": { - "type": "string", - "description": "User assigned to SessionHost." - } - } - }, - "SessionHostList": { - "type": "object", - "title": "SessionHostList", - "description": "List of SessionHost definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of SessionHost definitions.", - "items": { - "$ref": "#/definitions/SessionHost" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "UserSession": { - "type": "object", - "description": "Represents a UserSession definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for UserSession", - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserSessionProperties" - } - } - }, - "UserSessionProperties": { - "description": "Schema for UserSession properties.", - "type": "object", - "properties": { - "userPrincipalName": { - "type": "string", - "description": "The user principal name." - }, - "applicationType": { - "enum": [ - "RemoteApp", - "Desktop" - ], - "x-ms-enum": { - "name": "ApplicationType", - "modelAsString": true - }, - "type": "string", - "description": "Application type of application." - }, - "sessionState": { - "enum": [ - "Unknown", - "Active", - "Disconnected", - "Pending", - "LogOff", - "UserProfileDiskMounted" - ], - "x-ms-enum": { - "name": "SessionState", - "modelAsString": true - }, - "type": "string", - "description": "State of user session." - }, - "activeDirectoryUserName": { - "type": "string", - "description": "The active directory user name." - }, - "createTime": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the user session create." - } - } - }, - "UserSessionList": { - "type": "object", - "title": "UserSessionList", - "description": "List of UserSession definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of UserSession definitions.", - "items": { - "$ref": "#/definitions/UserSession" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - } - }, - "parameters": { - "HostPoolNameParameter": { - "name": "hostPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the host pool within the specified resource group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "ApplicationGroupNameParameter": { - "name": "applicationGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the application group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "ApplicationNameParameter": { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the application within the specified application group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "DesktopNameParameter": { - "name": "desktopName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the desktop within the specified desktop group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "WorkspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the workspace", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "SessionHostNameParameter": { - "name": "sessionHostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the session host within the specified host pool", - "maxLength": 48, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "UserSessionIdParameter": { - "name": "userSessionId", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the user session within the specified session host", - "maxLength": 24, - "minLength": 1, - "x-ms-parameter-location": "method" - }, - "StartMenuItemNameParameter": { - "name": "startMenuItemName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the start menu item within the specified host pool", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "version": "2019-09-24-preview", + "title": "Desktop Virtualization API Client" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List all of the available operations the Desktop Virtualization resource provider supports.", + "x-ms-examples": { + "OperationDescription_List": { + "$ref": "./examples/OperationDescription_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Get a workspace.", + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspace_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Successfully created workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Remove a workspace.", + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspace_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted workspace." + }, + "204": { + "description": "Workspace does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Update a workspace.", + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspace_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "List workspaces.", + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspace_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "List workspaces in subscription.", + "x-ms-examples": { + "Workspace_ListBySubscription": { + "$ref": "./examples/Workspace_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Get", + "description": "Get an application group.", + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroup_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_CreateOrUpdate", + "description": "Create or update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroup_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Successfully created application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Delete", + "description": "Remove an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Delete": { + "$ref": "./examples/ApplicationGroup_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application group." + }, + "204": { + "description": "Application group does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Update", + "description": "Update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroups_Update": { + "$ref": "./examples/ApplicationGroup_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListByResourceGroup", + "description": "List applicationGroups.", + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in resource group.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListBySubscription", + "description": "List applicationGroups in subscription.", + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroup_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in subscription.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "tags": [ + "StartMenuItem" + ], + "operationId": "StartMenuItems_List", + "description": "List start menu items in the given application group.", + "x-ms-examples": { + "StartMenuItem_List": { + "$ref": "./examples/StartMenuItem_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved start menu items in application group.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "description": "Get an application.", + "x-ms-examples": { + "Application_Get": { + "$ref": "./examples/Application_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Create or update an application.", + "x-ms-examples": { + "Application_Create": { + "$ref": "./examples/Application_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Successfully created application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "description": "Remove an application.", + "x-ms-examples": { + "Application_Delete": { + "$ref": "./examples/Application_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application." + }, + "204": { + "description": "Application does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "description": "Update an application.", + "x-ms-examples": { + "Application_Update": { + "$ref": "./examples/Application_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "description": "List applications.", + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Application_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved applications in application group.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Get", + "description": "Get a desktop.", + "x-ms-examples": { + "Desktop_Get": { + "$ref": "./examples/Desktop_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Update", + "description": "Update a desktop.", + "x-ms-examples": { + "Desktop_Update": { + "$ref": "./examples/Desktop_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + }, + { + "name": "desktop", + "description": "Object containing Desktop definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_List", + "description": "List desktops.", + "x-ms-examples": { + "Desktop_List": { + "$ref": "./examples/Desktop_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktops in application group.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Get", + "description": "Get a host pool.", + "x-ms-examples": { + "HostPool_Get": { + "$ref": "./examples/HostPool_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_CreateOrUpdate", + "description": "Create or update a host pool.", + "x-ms-examples": { + "HostPool_Create": { + "$ref": "./examples/HostPool_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Successfully created host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Delete", + "description": "Remove a host pool.", + "x-ms-examples": { + "HostPool_Delete": { + "$ref": "./examples/HostPool_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete sessionHost." + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool." + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Update", + "description": "Update a host pool.", + "x-ms-examples": { + "HostPool_Update": { + "$ref": "./examples/HostPool_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListByResourceGroup", + "description": "List hostPools.", + "x-ms-examples": { + "HostPool_ListByResourceGroup": { + "$ref": "./examples/HostPool_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_List", + "description": "List hostPools in subscription.", + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in subscription.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_ListByHostPool", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSession_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in host pool.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Get", + "description": "Get a session host.", + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHost_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Delete", + "description": "Remove a SessionHost.", + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHost_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to force sessionHost deletion even when userSession exists." + } + ], + "responses": { + "200": { + "description": "Successfully removed session host." + }, + "204": { + "description": "Session host does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Update", + "description": "Update a session host.", + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHost_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_List", + "description": "List sessionHosts.", + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHost_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session hosts in host pool.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Get", + "description": "Get a userSession.", + "x-ms-examples": { + "UserSession_Get": { + "$ref": "./examples/UserSession_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user session.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Delete", + "description": "Remove a userSession.", + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSession_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to login off userSession." + } + ], + "responses": { + "200": { + "description": "Successfully removed user session." + }, + "204": { + "description": "User session does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_List", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSession_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in session host.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Disconnect", + "description": "Disconnect a userSession.", + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSession_Disconnect_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disconnected user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_SendMessage", + "description": "Send a message to a user.", + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSession_SendMessage_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "sendMessage", + "description": "Object containing message includes title and message body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "Successfully sent message to user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error response of an operation failure" + }, + "ResourceProviderOperationList": { + "description": "Result of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + } + } + }, + "ResourceProviderOperation": { + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Desktop Virtualization.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + } + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceProperties": { + "description": "Schema for Workspace properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkspaceList": { + "type": "object", + "title": "WorkspaceList", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Workspace definitions.", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspacePatchProperties" + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupProperties" + } + } + }, + "ApplicationGroupProperties": { + "description": "Schema for ApplicationGroup properties.", + "type": "object", + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup.", + "x-nullable": false + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "x-nullable": false + } + } + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "ApplicationGroup properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupPatchProperties" + } + } + }, + "ApplicationGroupPatchProperties": { + "description": "ApplicationGroup properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + } + } + }, + "ApplicationGroupList": { + "type": "object", + "title": "ApplicationGroupList", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ApplicationGroup definitions.", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolProperties" + } + } + }, + "HostPoolProperties": { + "description": "Properties of HostPool.", + "type": "object", + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ], + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true + }, + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": false + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer.", + "x-nullable": false + }, + "ring": { + "type": "integer", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "ssoContext": { + "type": "string", + "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false + } + } + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "HostPool properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolPatchProperties" + } + } + }, + "HostPoolPatchProperties": { + "description": "Properties of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "ssoContext": { + "type": "string", + "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" + } + } + }, + "RegistrationInfo": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token.", + "x-nullable": false + } + } + }, + "RegistrationInfoPatch": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token." + } + } + }, + "SendMessage": { + "description": "Represents message sent to a UserSession.", + "type": "object", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "HostPoolList": { + "type": "object", + "title": "HostPoolList", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPool definitions.", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties" + } + } + }, + "ApplicationProperties": { + "description": "Schema for Application properties.", + "type": "object", + "required": [ + "commandLineSetting" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "x-nullable": false + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "ApplicationList": { + "type": "object", + "title": "ApplicationList", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Application definitions.", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPatchProperties" + } + } + }, + "ApplicationPatchProperties": { + "description": "Application properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + } + } + }, + "Desktop": { + "description": "Schema for Desktop properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopProperties" + } + } + }, + "DesktopProperties": { + "description": "Schema for Desktop properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array." + } + } + }, + "DesktopList": { + "type": "object", + "title": "DesktopList", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Desktop definitions.", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopPatchProperties" + } + } + }, + "DesktopPatchProperties": { + "description": "Desktop properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "StartMenuItemProperties": { + "description": "Schema for StartMenuItem properties.", + "type": "object", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + } + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for StartMenuItem", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StartMenuItemProperties" + } + } + }, + "StartMenuItemList": { + "type": "object", + "title": "StartMenuItemList", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of StartMenuItem definitions.", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostProperties" + } + } + }, + "SessionHostProperties": { + "description": "Schema for SessionHost properties.", + "type": "object", + "properties": { + "lastHeartBeat": { + "format": "date-time", + "type": "string", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "status": { + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "type": "string", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true + }, + "type": "string", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostPatchProperties" + } + } + }, + "SessionHostPatchProperties": { + "description": "SessionHost properties that can be patched.", + "type": "object", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + } + } + }, + "SessionHostList": { + "type": "object", + "title": "SessionHostList", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHost definitions.", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserSessionProperties" + } + } + }, + "UserSessionProperties": { + "description": "Schema for UserSession properties.", + "type": "object", + "properties": { + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Application type of application." + }, + "sessionState": { + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true + }, + "type": "string", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the user session create." + } + } + }, + "UserSessionList": { + "type": "object", + "title": "UserSessionList", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UserSession definitions.", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + } + }, + "parameters": { + "HostPoolNameParameter": { + "name": "hostPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the host pool within the specified resource group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationGroupNameParameter": { + "name": "applicationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application within the specified application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DesktopNameParameter": { + "name": "desktopName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the desktop within the specified desktop group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "SessionHostNameParameter": { + "name": "sessionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the session host within the specified host pool", + "maxLength": 48, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "UserSessionIdParameter": { + "name": "userSessionId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user session within the specified session host", + "maxLength": 24, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "StartMenuItemNameParameter": { + "name": "startMenuItemName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the start menu item within the specified host pool", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Create.json index 160d165ed001..b25c3f201e10 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Create.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview", - "applicationGroup": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "applicationGroupType": "RemoteApp" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - }, - "201": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview", + "applicationGroup": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType": "RemoteApp" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Delete.json index dc4c6d73650d..ae49e933b9d5 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Delete.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Get.json index 7afb8906e640..596b7b0e59ef 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Get.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_ListByResourceGroup.json index 838a52751007..a100cb01f057 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "api-version": "2019-09-24-preview", - "$filter": "applicationGroupType eq 'RailApplication'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - { - "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-09-24-preview", + "$filter": "applicationGroupType eq 'RailApplication'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Update.json index 82ad3c164a2f..885118119d93 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroup_Update.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview", - "applicationGroup": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Create.json index 2094f71a0da0..81c8546c3040 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Create.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-09-24-preview", - "application": { - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1 - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - }, - "201": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-09-24-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Delete.json index abb87bc9f1ba..657302f2d7fc 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Delete.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Get.json index 1fb18dc17d56..a6351fbcf9c4 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Get.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_List.json index 1b20415656af..d29a51e4b8d2 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_List.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - { - "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des2", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Update.json index dede8e927257..bb7d8a2416b8 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Application_Update.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-09-24-preview", - "application": { - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1 - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-09-24-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Get.json index 2719e939cce1..6f338696d815 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Get.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "desktopName": "SessionDesktop", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", - "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_List.json index 2b21a09458db..ed534bbd0a28 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_List.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", - "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Update.json index 30c010a1abeb..f20c28af8d7c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Desktop_Update.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "desktopName": "SessionDesktop", - "api-version": "2019-09-24-preview", - "desktop": { - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", - "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2019-09-24-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json index 269f61ac668d..a02c6dce9e30 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json @@ -1,92 +1,92 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-09-24-preview", - "hostPool": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - }, - "201": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-09-24-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Delete.json index c5241c91d1f4..6ba5b47fbac8 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Delete.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-09-24-preview", - "force": true - }, - "responses": { - "200": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-09-24-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json index 6e71147a4055..527a29aa0313 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json index d19d95f0785c..14d2ac43ee76 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json @@ -1,70 +1,70 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - }, - { - "name": "hostPool2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json index 3aa6110aa76f..ac148a60c444 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json @@ -1,71 +1,71 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - }, - { - "name": "hostPool2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json index d13bcaee2943..542fba444f44 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-09-24-preview", - "hostPool": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "personalDesktopAssignmentType": "Automatic", - "registrationInfo": { - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath" - } - } - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Shared", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-09-24-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Shared", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/OperationDescription_List.json index 4ef6c3629a41..2c87491a4ff3 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/OperationDescription_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/OperationDescription_List.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DesktopVirtualization/ssocontext/read", - "display": { - "provider": "Microsoft.DesktopVirtualization", - "resource": "ssocontext" - } - }, - { - "name": "Microsoft.DesktopVirtualization/ssocontext/write", - "display": { - "provider": "Microsoft.DesktopVirtualization", - "resource": "ssocontext" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/ssocontext/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "ssocontext" + } + }, + { + "name": "Microsoft.DesktopVirtualization/ssocontext/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "ssocontext" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json index 9a8b84e064d4..11fd9ae2d5c8 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-09-24-preview", - "force": true - }, - "responses": { - "200": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-09-24-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json index 4ebf983e1b15..e40bf736ef29 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json index 45f5784ec15c..8080e4264578 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - }, - { - "name": "sessionHost2.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user2@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json index 42a06c3969a6..7c87d13ff58e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-09-24-preview", - "sessionHost": { - "properties": { - "allowNewSession": true, - "assignedUser": "user1@microsoft.com" - } - } - }, - "responses": { - "200": { - "body": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2019-01-24T20:00:08.2893033Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-09-24-preview", + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/StartMenuItem_List.json index d6b527527568..56b2c0d44ecb 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/StartMenuItem_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/StartMenuItem_List.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", - "properties": { - "appAlias": "word", - "friendlyName": "friendly", - "filePath": "/path/to/file", - "commandLineArguments": "arguments", - "iconPath": "/path/to/icon", - "iconIndex": 1 - } - }, - { - "name": "application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", - "properties": { - "appAlias": "excel", - "friendlyName": "friendly", - "filePath": "/path/to/file", - "commandLineArguments": "arguments", - "iconPath": "/path/to/icon", - "iconIndex": 1 - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "friendlyName": "friendly", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "friendlyName": "friendly", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Delete.json index 3011afc4e0cf..2d0eb21bbbe2 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Delete.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-09-24-preview", - "force": true - }, - "responses": { - "200": { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-09-24-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Disconnect_Post.json index e20ff3b8a3f3..46da447c9c30 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Disconnect_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Disconnect_Post.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Get.json index 63830ee6ed1c..98b9092dc0ef 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_List.json index a99ae4daf9ce..dae48683f572 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_List.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - }, - { - "name": "2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_SendMessage_Post.json index 5249b6aed3aa..5a08be5a2bfe 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_SendMessage_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/UserSession_SendMessage_Post.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-09-24-preview", - "sendMessage": { - "messageTitle": "title", - "messageBody": "body" - } - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-09-24-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Create.json index 3aafb846a207..655fc336413f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Create.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-09-24-preview", - "workspace": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "201": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-09-24-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Delete.json index 8860d04f7780..b44d9d84506d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Delete.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Get.json index 0f56eed4ba01..33e19873fc84 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_ListByResourceGroup.json index 076d2b1f8c51..52b52f69a47c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_ListByResourceGroup.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "api-version": "2019-09-24-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - }, - { - "name": "workspace2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-09-24-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Update.json index a9076582e165..1f8b722f0c87 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/Workspace_Update.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-09-24-preview", - "workspace": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-09-24-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json index 08655276ef04..c304375fc6a4 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json @@ -1,3032 +1,3032 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-12-10-preview", - "title": "Desktop Virtualization API Client" - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "host": "management.azure.com", - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.DesktopVirtualization/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "List all of the available operations the Desktop Virtualization resource provider supports.", - "x-ms-examples": { - "OperationDescription_List": { - "$ref": "./examples/OperationDescription_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved operations.", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationList" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Get", - "description": "Get a workspace.", - "x-ms-examples": { - "Workspace_Get": { - "$ref": "./examples/Workspace_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_CreateOrUpdate", - "description": "Create or update a workspace.", - "x-ms-examples": { - "Workspace_Create": { - "$ref": "./examples/Workspace_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspace", - "description": "Object containing Workspace definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "201": { - "description": "Successfully created workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Delete", - "description": "Remove a workspace.", - "x-ms-examples": { - "Workspace_Delete": { - "$ref": "./examples/Workspace_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted workspace." - }, - "204": { - "description": "Workspace does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Update", - "description": "Update a workspace.", - "x-ms-examples": { - "Workspace_Update": { - "$ref": "./examples/Workspace_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspace", - "description": "Object containing Workspace definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/WorkspacePatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListByResourceGroup", - "description": "List workspaces.", - "x-ms-examples": { - "Workspace_ListByResourceGroup": { - "$ref": "./examples/Workspace_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspaces in resource group.", - "schema": { - "$ref": "#/definitions/WorkspaceList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListBySubscription", - "description": "List workspaces in subscription.", - "x-ms-examples": { - "Workspace_ListBySubscription": { - "$ref": "./examples/Workspace_ListBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved workspaces in subscription.", - "schema": { - "$ref": "#/definitions/WorkspaceList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Get", - "description": "Get an application group.", - "x-ms-examples": { - "ApplicationGroup_Get": { - "$ref": "./examples/ApplicationGroup_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_CreateOrUpdate", - "description": "Create or update an applicationGroup.", - "x-ms-examples": { - "ApplicationGroup_Create": { - "$ref": "./examples/ApplicationGroup_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "applicationGroup", - "description": "Object containing ApplicationGroup definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "201": { - "description": "Successfully created application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Delete", - "description": "Remove an applicationGroup.", - "x-ms-examples": { - "ApplicationGroup_Delete": { - "$ref": "./examples/ApplicationGroup_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully removed application group." - }, - "204": { - "description": "Application group does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_Update", - "description": "Update an applicationGroup.", - "x-ms-examples": { - "ApplicationGroups_Update": { - "$ref": "./examples/ApplicationGroup_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "name": "applicationGroup", - "description": "Object containing ApplicationGroup definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApplicationGroupPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application group.", - "schema": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_ListByResourceGroup", - "description": "List applicationGroups.", - "x-ms-examples": { - "ApplicationGroup_ListByResourceGroup": { - "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application groups in resource group.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroups_ListBySubscription", - "description": "List applicationGroups in subscription.", - "x-ms-examples": { - "ApplicationGroup_List": { - "$ref": "./examples/ApplicationGroup_ListBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application groups in subscription.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { - "get": { - "tags": [ - "StartMenuItem" - ], - "operationId": "StartMenuItems_List", - "description": "List start menu items in the given application group.", - "x-ms-examples": { - "StartMenuItem_List": { - "$ref": "./examples/StartMenuItem_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved start menu items in application group.", - "schema": { - "$ref": "#/definitions/StartMenuItemList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_Get", - "description": "Get an application.", - "x-ms-examples": { - "Application_Get": { - "$ref": "./examples/Application_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "Application" - ], - "operationId": "Applications_CreateOrUpdate", - "description": "Create or update an application.", - "x-ms-examples": { - "Application_Create": { - "$ref": "./examples/Application_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "name": "application", - "description": "Object containing Application definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Application" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "201": { - "description": "Successfully created application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "Application" - ], - "operationId": "Applications_Delete", - "description": "Remove an application.", - "x-ms-examples": { - "Application_Delete": { - "$ref": "./examples/Application_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully removed application." - }, - "204": { - "description": "Application does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Application" - ], - "operationId": "Applications_Update", - "description": "Update an application.", - "x-ms-examples": { - "Application_Update": { - "$ref": "./examples/Application_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "name": "application", - "description": "Object containing Application definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApplicationPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated application.", - "schema": { - "$ref": "#/definitions/Application" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_List", - "description": "List applications.", - "x-ms-examples": { - "Applications_List": { - "$ref": "./examples/Application_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved applications in application group.", - "schema": { - "$ref": "#/definitions/ApplicationList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { - "get": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_Get", - "description": "Get a desktop.", - "x-ms-examples": { - "Desktop_Get": { - "$ref": "./examples/Desktop_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/DesktopNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved desktop.", - "schema": { - "$ref": "#/definitions/Desktop" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_Update", - "description": "Update a desktop.", - "x-ms-examples": { - "Desktop_Update": { - "$ref": "./examples/Desktop_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - }, - { - "$ref": "#/parameters/DesktopNameParameter" - }, - { - "name": "desktop", - "description": "Object containing Desktop definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DesktopPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated desktop.", - "schema": { - "$ref": "#/definitions/Desktop" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { - "get": { - "tags": [ - "Desktop" - ], - "operationId": "Desktops_List", - "description": "List desktops.", - "x-ms-examples": { - "Desktop_List": { - "$ref": "./examples/Desktop_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApplicationGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved desktops in application group.", - "schema": { - "$ref": "#/definitions/DesktopList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Get", - "description": "Get a host pool.", - "x-ms-examples": { - "HostPool_Get": { - "$ref": "./examples/HostPool_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_CreateOrUpdate", - "description": "Create or update a host pool.", - "x-ms-examples": { - "HostPool_Create": { - "$ref": "./examples/HostPool_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "hostPool", - "description": "Object containing HostPool definitions.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HostPool" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "201": { - "description": "Successfully created host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Delete", - "description": "Remove a host pool.", - "x-ms-examples": { - "HostPool_Delete": { - "$ref": "./examples/HostPool_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to delete sessionHost." - } - ], - "responses": { - "200": { - "description": "Successfully removed host pool." - }, - "204": { - "description": "Host pool does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_Update", - "description": "Update a host pool.", - "x-ms-examples": { - "HostPool_Update": { - "$ref": "./examples/HostPool_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "hostPool", - "description": "Object containing HostPool definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/HostPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated host pool.", - "schema": { - "$ref": "#/definitions/HostPool" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_ListByResourceGroup", - "description": "List hostPools.", - "x-ms-examples": { - "HostPool_ListByResourceGroup": { - "$ref": "./examples/HostPool_ListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool in resource group.", - "schema": { - "$ref": "#/definitions/HostPoolList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { - "get": { - "tags": [ - "HostPool" - ], - "operationId": "HostPools_List", - "description": "List hostPools in subscription.", - "x-ms-examples": { - "HostPool_List": { - "$ref": "./examples/HostPool_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved host pool in subscription.", - "schema": { - "$ref": "#/definitions/HostPoolList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_ListByHostPool", - "description": "List userSessions.", - "x-ms-examples": { - "UserSession_ListByHostPool": { - "$ref": "./examples/UserSession_ListByHostPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user sessions in host pool.", - "schema": { - "$ref": "#/definitions/UserSessionList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { - "get": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Get", - "description": "Get a session host.", - "x-ms-examples": { - "SessionHost_Get": { - "$ref": "./examples/SessionHost_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved session host.", - "schema": { - "$ref": "#/definitions/SessionHost" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Delete", - "description": "Remove a SessionHost.", - "x-ms-examples": { - "SessionHost_Delete": { - "$ref": "./examples/SessionHost_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to force sessionHost deletion even when userSession exists." - } - ], - "responses": { - "200": { - "description": "Successfully removed session host." - }, - "204": { - "description": "Session host does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_Update", - "description": "Update a session host.", - "x-ms-examples": { - "SessionHost_Update": { - "$ref": "./examples/SessionHost_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "sessionHost", - "description": "Object containing SessionHost definitions.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SessionHostPatch" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated session host.", - "schema": { - "$ref": "#/definitions/SessionHost" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { - "get": { - "tags": [ - "SessionHost" - ], - "operationId": "SessionHosts_List", - "description": "List sessionHosts.", - "x-ms-examples": { - "SessionHost_List": { - "$ref": "./examples/SessionHost_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved session hosts in host pool.", - "schema": { - "$ref": "#/definitions/SessionHostList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Get", - "description": "Get a userSession.", - "x-ms-examples": { - "UserSession_Get": { - "$ref": "./examples/UserSession_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user session.", - "schema": { - "$ref": "#/definitions/UserSession" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Delete", - "description": "Remove a userSession.", - "x-ms-examples": { - "UserSession_Delete": { - "$ref": "./examples/UserSession_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "Force flag to login off userSession." - } - ], - "responses": { - "200": { - "description": "Successfully removed user session." - }, - "204": { - "description": "User session does not exist." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { - "get": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_List", - "description": "List userSessions.", - "x-ms-examples": { - "UserSession_List": { - "$ref": "./examples/UserSession_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user sessions in session host.", - "schema": { - "$ref": "#/definitions/UserSessionList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { - "post": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_Disconnect", - "description": "Disconnect a userSession.", - "x-ms-examples": { - "UserSession_Disconnect_Post": { - "$ref": "./examples/UserSession_Disconnect_Post.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully disconnected user session." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { - "post": { - "tags": [ - "UserSession" - ], - "operationId": "UserSessions_SendMessage", - "description": "Send a message to a user.", - "x-ms-examples": { - "UserSession_SendMessage_Post": { - "$ref": "./examples/UserSession_SendMessage_Post.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "$ref": "#/parameters/UserSessionIdParameter" - }, - { - "name": "sendMessage", - "description": "Object containing message includes title and message body", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SendMessage" - } - } - ], - "responses": { - "200": { - "description": "Successfully sent message to user session." - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "CloudError": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error response of an operation failure" - }, - "ResourceProviderOperationList": { - "description": "Result of the request to list operations.", - "readOnly": true, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperation" - }, - "description": "List of operations supported by this resource provider." - } - } - }, - "ResourceProviderOperation": { - "description": "Supported operation of this resource provider.", - "readOnly": true, - "properties": { - "name": { - "description": "Operation name, in format of {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Resource provider: Microsoft Desktop Virtualization.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "Type of operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of this operation.", - "type": "string" - } - } - } - } - }, - "Workspace": { - "type": "object", - "description": "Represents a Workspace definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for Workspace", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspaceProperties" - } - } - }, - "WorkspaceProperties": { - "description": "Schema for Workspace properties.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Workspace." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Workspace." - }, - "applicationGroupReferences": { - "type": "array", - "description": "List of applicationGroup resource Ids.", - "items": { - "type": "string" - } - } - } - }, - "WorkspaceList": { - "type": "object", - "title": "WorkspaceList", - "description": "List of Workspace definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Workspace definitions.", - "items": { - "$ref": "#/definitions/Workspace" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "WorkspacePatch": { - "type": "object", - "description": "Workspace properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Workspace", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspacePatchProperties" - } - } - }, - "WorkspacePatchProperties": { - "description": "Workspace properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Workspace." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Workspace." - }, - "applicationGroupReferences": { - "type": "array", - "description": "List of applicationGroup links.", - "items": { - "type": "string" - } - } - } - }, - "ApplicationGroup": { - "type": "object", - "description": "Represents a ApplicationGroup definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for ApplicationGroup", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGroupProperties", - "x-nullable": false - } - } - }, - "ApplicationGroupProperties": { - "description": "Schema for ApplicationGroup properties.", - "type": "object", - "required": [ - "hostPoolArmPath", - "applicationGroupType" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of ApplicationGroup." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of ApplicationGroup." - }, - "hostPoolArmPath": { - "type": "string", - "description": "HostPool arm path of ApplicationGroup.", - "x-nullable": false - }, - "workspaceArmPath": { - "type": "string", - "description": "Workspace arm path of ApplicationGroup.", - "readOnly": true - }, - "applicationGroupType": { - "enum": [ - "RemoteApp", - "Desktop" - ], - "x-ms-enum": { - "name": "ApplicationGroupType", - "modelAsString": true - }, - "type": "string", - "description": "Resource Type of ApplicationGroup.", - "x-nullable": false - } - } - }, - "ApplicationGroupPatch": { - "type": "object", - "description": "ApplicationGroup properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "tags to be updated" - }, - "properties": { - "description": "ApplicationGroup properties that can be patched.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationGroupPatchProperties" - } - } - }, - "ApplicationGroupPatchProperties": { - "description": "ApplicationGroup properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of ApplicationGroup." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of ApplicationGroup." - } - } - }, - "ApplicationGroupList": { - "type": "object", - "title": "ApplicationGroupList", - "description": "List of ApplicationGroup definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of ApplicationGroup definitions.", - "items": { - "$ref": "#/definitions/ApplicationGroup" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "HostPool": { - "type": "object", - "description": "Represents a HostPool definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for HostPool", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HostPoolProperties", - "x-nullable": false - } - } - }, - "HostPoolProperties": { - "description": "Properties of HostPool.", - "type": "object", - "required": [ - "hostPoolType", - "loadBalancerType", - "preferredAppGroupType" - ], - "properties": { - "friendlyName": { - "type": "string", - "description": "Friendly name of HostPool." - }, - "description": { - "type": "string", - "description": "Description of HostPool." - }, - "hostPoolType": { - "enum": [ - "Personal", - "Pooled" - ], - "x-ms-enum": { - "name": "HostPoolType", - "modelAsString": true - }, - "type": "string", - "description": "HostPool type for desktop.", - "x-nullable": false - }, - "personalDesktopAssignmentType": { - "enum": [ - "Automatic", - "Direct" - ], - "x-ms-enum": { - "name": "PersonalDesktopAssignmentType", - "modelAsString": true - }, - "type": "string", - "description": "PersonalDesktopAssignment type for HostPool.", - "x-nullable": false - }, - "customRdpProperty": { - "type": "string", - "description": "Custom rdp property of HostPool." - }, - "maxSessionLimit": { - "type": "integer", - "description": "The max session limit of HostPool." - }, - "loadBalancerType": { - "enum": [ - "BreadthFirst", - "DepthFirst", - "Persistent" - ], - "x-ms-enum": { - "name": "LoadBalancerType", - "modelAsString": true - }, - "type": "string", - "description": "The type of the load balancer.", - "x-nullable": false - }, - "ring": { - "type": "integer", - "description": "The ring number of HostPool." - }, - "validationEnvironment": { - "type": "boolean", - "description": "Is validation environment." - }, - "registrationInfo": { - "$ref": "#/definitions/RegistrationInfo", - "description": "The registration info of HostPool." - }, - "vmTemplate": { - "type": "string", - "description": "VM template for sessionhosts configuration within hostpool." - }, - "applicationGroupReferences": { - "readOnly": true, - "type": "array", - "description": "List of applicationGroup links.", - "items": { - "type": "string" - } - }, - "ssoContext": { - "type": "string", - "description": "Path to keyvault containing ssoContext secret." - }, - "preferredAppGroupType": { - "enum": [ - "None", - "Desktop", - "RailApplications" - ], - "x-ms-enum": { - "name": "PreferredAppGroupType", - "modelAsString": true - }, - "type": "string", - "description": "The type of preferred application group type, default to Desktop Application Group", - "x-nullable": false - } - } - }, - "HostPoolPatch": { - "type": "object", - "description": "HostPool properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "tags to be updated" - }, - "properties": { - "description": "HostPool properties that can be patched.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HostPoolPatchProperties" - } - } - }, - "HostPoolPatchProperties": { - "description": "Properties of HostPool.", - "type": "object", - "properties": { - "friendlyName": { - "type": "string", - "description": "Friendly name of HostPool." - }, - "description": { - "type": "string", - "description": "Description of HostPool." - }, - "customRdpProperty": { - "type": "string", - "description": "Custom rdp property of HostPool." - }, - "maxSessionLimit": { - "type": "integer", - "description": "The max session limit of HostPool." - }, - "personalDesktopAssignmentType": { - "enum": [ - "Automatic", - "Direct" - ], - "x-ms-enum": { - "name": "PersonalDesktopAssignmentType", - "modelAsString": true - }, - "type": "string", - "description": "PersonalDesktopAssignment type for HostPool." - }, - "loadBalancerType": { - "enum": [ - "BreadthFirst", - "DepthFirst", - "Persistent" - ], - "x-ms-enum": { - "name": "LoadBalancerType", - "modelAsString": true - }, - "type": "string", - "description": "The type of the load balancer." - }, - "ring": { - "type": "integer", - "description": "The ring number of HostPool." - }, - "validationEnvironment": { - "type": "boolean", - "description": "Is validation environment." - }, - "registrationInfo": { - "$ref": "#/definitions/RegistrationInfoPatch", - "description": "The registration info of HostPool." - }, - "vmTemplate": { - "type": "string", - "description": "VM template for sessionhosts configuration within hostpool." - }, - "ssoContext": { - "type": "string", - "description": "Path to keyvault containing ssoContext secret." - }, - "preferredAppGroupType": { - "enum": [ - "None", - "Desktop", - "RailApplications" - ], - "x-ms-enum": { - "name": "PreferredAppGroupType", - "modelAsString": true - }, - "type": "string", - "description": "The type of preferred application group type, default to Desktop Application Group" - } - } - }, - "RegistrationInfo": { - "description": "Represents a RegistrationInfo definition.", - "type": "object", - "properties": { - "expirationTime": { - "format": "date-time", - "type": "string", - "description": "Expiration time of registration token." - }, - "token": { - "type": "string", - "description": "The registration token base64 encoded string." - }, - "registrationTokenOperation": { - "enum": [ - "Delete", - "None", - "Update" - ], - "x-ms-enum": { - "name": "RegistrationTokenOperation", - "modelAsString": true - }, - "type": "string", - "description": "The type of resetting the token.", - "x-nullable": false - } - } - }, - "RegistrationInfoPatch": { - "description": "Represents a RegistrationInfo definition.", - "type": "object", - "properties": { - "expirationTime": { - "format": "date-time", - "type": "string", - "description": "Expiration time of registration token." - }, - "registrationTokenOperation": { - "enum": [ - "Delete", - "None", - "Update" - ], - "x-ms-enum": { - "name": "RegistrationTokenOperation", - "modelAsString": true - }, - "type": "string", - "description": "The type of resetting the token." - } - } - }, - "SendMessage": { - "description": "Represents message sent to a UserSession.", - "type": "object", - "properties": { - "messageTitle": { - "type": "string", - "description": "Title of message." - }, - "messageBody": { - "type": "string", - "description": "Body of message." - } - } - }, - "HostPoolList": { - "type": "object", - "title": "HostPoolList", - "description": "List of HostPool definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of HostPool definitions.", - "items": { - "$ref": "#/definitions/HostPool" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "Application": { - "description": "Schema for Application properties.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "description": "Detailed properties for Application", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationProperties", - "x-nullable": false - } - } - }, - "ApplicationProperties": { - "description": "Schema for Application properties.", - "type": "object", - "required": [ - "commandLineSetting" - ], - "properties": { - "description": { - "type": "string", - "description": "Description of Application." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Application." - }, - "filePath": { - "type": "string", - "description": "Specifies a path for the executable file for the application." - }, - "commandLineSetting": { - "enum": [ - "DoNotAllow", - "Allow", - "Require" - ], - "x-ms-enum": { - "name": "CommandLineSetting", - "modelAsString": true - }, - "type": "string", - "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", - "x-nullable": false - }, - "commandLineArguments": { - "type": "string", - "description": "Command Line Arguments for Application." - }, - "showInPortal": { - "type": "boolean", - "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." - }, - "iconPath": { - "type": "string", - "description": "Path to icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - }, - "iconHash": { - "readOnly": true, - "type": "string", - "description": "Hash of the icon." - }, - "iconContent": { - "readOnly": true, - "type": "string", - "format": "byte", - "description": "the icon a 64 bit string as a byte array." - } - } - }, - "ApplicationList": { - "type": "object", - "title": "ApplicationList", - "description": "List of Application definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Application definitions.", - "items": { - "$ref": "#/definitions/Application" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "ApplicationPatch": { - "type": "object", - "description": "Application properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Application", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationPatchProperties" - } - } - }, - "ApplicationPatchProperties": { - "description": "Application properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Application." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Application." - }, - "filePath": { - "type": "string", - "description": "Specifies a path for the executable file for the application." - }, - "commandLineSetting": { - "enum": [ - "DoNotAllow", - "Allow", - "Require" - ], - "x-ms-enum": { - "name": "CommandLineSetting", - "modelAsString": true - }, - "type": "string", - "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." - }, - "commandLineArguments": { - "type": "string", - "description": "Command Line Arguments for Application." - }, - "showInPortal": { - "type": "boolean", - "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." - }, - "iconPath": { - "type": "string", - "description": "Path to icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - } - } - }, - "Desktop": { - "description": "Schema for Desktop properties.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for Desktop", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DesktopProperties" - } - } - }, - "DesktopProperties": { - "description": "Schema for Desktop properties.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Desktop." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Desktop." - }, - "iconHash": { - "readOnly": true, - "type": "string", - "description": "Hash of the icon." - }, - "iconContent": { - "readOnly": true, - "type": "string", - "format": "byte", - "description": "The icon a 64 bit string as a byte array." - } - } - }, - "DesktopList": { - "type": "object", - "title": "DesktopList", - "description": "List of Desktop definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of Desktop definitions.", - "items": { - "$ref": "#/definitions/Desktop" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "DesktopPatch": { - "type": "object", - "description": "Desktop properties that can be patched.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "tags to be updated" - }, - "properties": { - "description": "Detailed properties for Desktop", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DesktopPatchProperties" - } - } - }, - "DesktopPatchProperties": { - "description": "Desktop properties that can be patched.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Desktop." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of Desktop." - } - } - }, - "StartMenuItemProperties": { - "description": "Schema for StartMenuItem properties.", - "type": "object", - "properties": { - "appAlias": { - "type": "string", - "description": "Alias of StartMenuItem." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name of StartMenuItem." - }, - "filePath": { - "type": "string", - "description": "Path to the file of StartMenuItem." - }, - "commandLineArguments": { - "type": "string", - "description": "Command line arguments for StartMenuItem." - }, - "iconPath": { - "type": "string", - "description": "Path to the icon." - }, - "iconIndex": { - "type": "integer", - "description": "Index of the icon." - } - } - }, - "StartMenuItem": { - "type": "object", - "description": "Represents a StartMenuItem definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for StartMenuItem", - "x-ms-client-flatten": true, - "$ref": "#/definitions/StartMenuItemProperties" - } - } - }, - "StartMenuItemList": { - "type": "object", - "title": "StartMenuItemList", - "description": "List of StartMenuItem definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of StartMenuItem definitions.", - "items": { - "$ref": "#/definitions/StartMenuItem" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "SessionHost": { - "type": "object", - "description": "Represents a SessionHost definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for SessionHost", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SessionHostProperties" - } - } - }, - "SessionHostProperties": { - "description": "Schema for SessionHost properties.", - "type": "object", - "properties": { - "lastHeartBeat": { - "format": "date-time", - "type": "string", - "description": "Last heart beat from SessionHost." - }, - "sessions": { - "type": "integer", - "description": "Number of sessions on SessionHost." - }, - "agentVersion": { - "type": "string", - "description": "Version of agent on SessionHost." - }, - "allowNewSession": { - "type": "boolean", - "description": "Allow a new session." - }, - "virtualMachineId": { - "type": "string", - "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", - "readOnly": true - }, - "resourceId": { - "type": "string", - "description": "Resource Id of SessionHost's underlying virtual machine.", - "readOnly": true - }, - "assignedUser": { - "type": "string", - "description": "User assigned to SessionHost." - }, - "status": { - "enum": [ - "Available", - "Unavailable", - "Shutdown", - "Disconnected", - "Upgrading", - "UpgradeFailed" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - }, - "type": "string", - "description": "Status for a SessionHost." - }, - "statusTimestamp": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the status.", - "readOnly": true - }, - "osVersion": { - "type": "string", - "description": "The version of the OS on the session host." - }, - "sxSStackVersion": { - "type": "string", - "description": "The version of the side by side stack on the session host." - }, - "updateState": { - "enum": [ - "Initial", - "Pending", - "Started", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "UpdateState", - "modelAsString": true - }, - "type": "string", - "description": "Update state of a SessionHost." - }, - "lastUpdateTime": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the last update.", - "readOnly": true - }, - "updateErrorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "SessionHostPatch": { - "type": "object", - "description": "SessionHost properties that can be patched.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for SessionHost", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SessionHostPatchProperties" - } - } - }, - "SessionHostPatchProperties": { - "description": "SessionHost properties that can be patched.", - "type": "object", - "properties": { - "allowNewSession": { - "type": "boolean", - "description": "Allow a new session." - }, - "assignedUser": { - "type": "string", - "description": "User assigned to SessionHost." - } - } - }, - "SessionHostList": { - "type": "object", - "title": "SessionHostList", - "description": "List of SessionHost definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of SessionHost definitions.", - "items": { - "$ref": "#/definitions/SessionHost" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, - "UserSession": { - "type": "object", - "description": "Represents a UserSession definition.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Detailed properties for UserSession", - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserSessionProperties" - } - } - }, - "UserSessionProperties": { - "description": "Schema for UserSession properties.", - "type": "object", - "properties": { - "userPrincipalName": { - "type": "string", - "description": "The user principal name." - }, - "applicationType": { - "enum": [ - "RemoteApp", - "Desktop" - ], - "x-ms-enum": { - "name": "ApplicationType", - "modelAsString": true - }, - "type": "string", - "description": "Application type of application." - }, - "sessionState": { - "enum": [ - "Unknown", - "Active", - "Disconnected", - "Pending", - "LogOff", - "UserProfileDiskMounted" - ], - "x-ms-enum": { - "name": "SessionState", - "modelAsString": true - }, - "type": "string", - "description": "State of user session." - }, - "activeDirectoryUserName": { - "type": "string", - "description": "The active directory user name." - }, - "createTime": { - "format": "date-time", - "type": "string", - "description": "The timestamp of the user session create." - } - } - }, - "UserSessionList": { - "type": "object", - "title": "UserSessionList", - "description": "List of UserSession definitions.", - "properties": { - "value": { - "type": "array", - "description": "List of UserSession definitions.", - "items": { - "$ref": "#/definitions/UserSession" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - } - }, - "parameters": { - "HostPoolNameParameter": { - "name": "hostPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the host pool within the specified resource group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "ApplicationGroupNameParameter": { - "name": "applicationGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the application group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "ApplicationNameParameter": { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the application within the specified application group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "DesktopNameParameter": { - "name": "desktopName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the desktop within the specified desktop group", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "WorkspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the workspace", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "SessionHostNameParameter": { - "name": "sessionHostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the session host within the specified host pool", - "maxLength": 48, - "minLength": 3, - "x-ms-parameter-location": "method" - }, - "UserSessionIdParameter": { - "name": "userSessionId", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the user session within the specified session host", - "maxLength": 24, - "minLength": 1, - "x-ms-parameter-location": "method" - }, - "StartMenuItemNameParameter": { - "name": "startMenuItemName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the start menu item within the specified host pool", - "maxLength": 24, - "minLength": 3, - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "version": "2019-12-10-preview", + "title": "Desktop Virtualization API Client" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List all of the available operations the Desktop Virtualization resource provider supports.", + "x-ms-examples": { + "OperationDescription_List": { + "$ref": "./examples/OperationDescription_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Get a workspace.", + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspace_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Successfully created workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Remove a workspace.", + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspace_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted workspace." + }, + "204": { + "description": "Workspace does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Update a workspace.", + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspace_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "List workspaces.", + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspace_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "List workspaces in subscription.", + "x-ms-examples": { + "Workspace_ListBySubscription": { + "$ref": "./examples/Workspace_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Get", + "description": "Get an application group.", + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroup_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_CreateOrUpdate", + "description": "Create or update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroup_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Successfully created application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Delete", + "description": "Remove an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Delete": { + "$ref": "./examples/ApplicationGroup_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application group." + }, + "204": { + "description": "Application group does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Update", + "description": "Update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroups_Update": { + "$ref": "./examples/ApplicationGroup_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListByResourceGroup", + "description": "List applicationGroups.", + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in resource group.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListBySubscription", + "description": "List applicationGroups in subscription.", + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroup_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in subscription.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "tags": [ + "StartMenuItem" + ], + "operationId": "StartMenuItems_List", + "description": "List start menu items in the given application group.", + "x-ms-examples": { + "StartMenuItem_List": { + "$ref": "./examples/StartMenuItem_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved start menu items in application group.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "description": "Get an application.", + "x-ms-examples": { + "Application_Get": { + "$ref": "./examples/Application_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Create or update an application.", + "x-ms-examples": { + "Application_Create": { + "$ref": "./examples/Application_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Successfully created application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "description": "Remove an application.", + "x-ms-examples": { + "Application_Delete": { + "$ref": "./examples/Application_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application." + }, + "204": { + "description": "Application does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "description": "Update an application.", + "x-ms-examples": { + "Application_Update": { + "$ref": "./examples/Application_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "description": "List applications.", + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Application_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved applications in application group.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Get", + "description": "Get a desktop.", + "x-ms-examples": { + "Desktop_Get": { + "$ref": "./examples/Desktop_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Update", + "description": "Update a desktop.", + "x-ms-examples": { + "Desktop_Update": { + "$ref": "./examples/Desktop_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + }, + { + "name": "desktop", + "description": "Object containing Desktop definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_List", + "description": "List desktops.", + "x-ms-examples": { + "Desktop_List": { + "$ref": "./examples/Desktop_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktops in application group.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Get", + "description": "Get a host pool.", + "x-ms-examples": { + "HostPool_Get": { + "$ref": "./examples/HostPool_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_CreateOrUpdate", + "description": "Create or update a host pool.", + "x-ms-examples": { + "HostPool_Create": { + "$ref": "./examples/HostPool_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Successfully created host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Delete", + "description": "Remove a host pool.", + "x-ms-examples": { + "HostPool_Delete": { + "$ref": "./examples/HostPool_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete sessionHost." + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool." + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Update", + "description": "Update a host pool.", + "x-ms-examples": { + "HostPool_Update": { + "$ref": "./examples/HostPool_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListByResourceGroup", + "description": "List hostPools.", + "x-ms-examples": { + "HostPool_ListByResourceGroup": { + "$ref": "./examples/HostPool_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_List", + "description": "List hostPools in subscription.", + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in subscription.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_ListByHostPool", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSession_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in host pool.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Get", + "description": "Get a session host.", + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHost_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Delete", + "description": "Remove a SessionHost.", + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHost_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to force sessionHost deletion even when userSession exists." + } + ], + "responses": { + "200": { + "description": "Successfully removed session host." + }, + "204": { + "description": "Session host does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Update", + "description": "Update a session host.", + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHost_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_List", + "description": "List sessionHosts.", + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHost_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session hosts in host pool.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Get", + "description": "Get a userSession.", + "x-ms-examples": { + "UserSession_Get": { + "$ref": "./examples/UserSession_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user session.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Delete", + "description": "Remove a userSession.", + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSession_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to login off userSession." + } + ], + "responses": { + "200": { + "description": "Successfully removed user session." + }, + "204": { + "description": "User session does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_List", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSession_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in session host.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Disconnect", + "description": "Disconnect a userSession.", + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSession_Disconnect_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disconnected user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_SendMessage", + "description": "Send a message to a user.", + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSession_SendMessage_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "sendMessage", + "description": "Object containing message includes title and message body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "Successfully sent message to user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error response of an operation failure" + }, + "ResourceProviderOperationList": { + "description": "Result of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + } + } + }, + "ResourceProviderOperation": { + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Desktop Virtualization.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + } + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceProperties": { + "description": "Schema for Workspace properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + } + } + }, + "WorkspaceList": { + "type": "object", + "title": "WorkspaceList", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Workspace definitions.", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspacePatchProperties" + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupProperties", + "x-nullable": false + } + } + }, + "ApplicationGroupProperties": { + "description": "Schema for ApplicationGroup properties.", + "type": "object", + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup.", + "x-nullable": false + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "x-nullable": false + } + } + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "ApplicationGroup properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupPatchProperties" + } + } + }, + "ApplicationGroupPatchProperties": { + "description": "ApplicationGroup properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + } + } + }, + "ApplicationGroupList": { + "type": "object", + "title": "ApplicationGroupList", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ApplicationGroup definitions.", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolProperties", + "x-nullable": false + } + } + }, + "HostPoolProperties": { + "description": "Properties of HostPool.", + "type": "object", + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ], + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "enum": [ + "Personal", + "Pooled" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true + }, + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "x-nullable": false + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer.", + "x-nullable": false + }, + "ring": { + "type": "integer", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "ssoContext": { + "type": "string", + "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false + } + } + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "HostPool properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolPatchProperties" + } + } + }, + "HostPoolPatchProperties": { + "description": "Properties of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "ssoContext": { + "type": "string", + "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" + } + } + }, + "RegistrationInfo": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token.", + "x-nullable": false + } + } + }, + "RegistrationInfoPatch": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token." + } + } + }, + "SendMessage": { + "description": "Represents message sent to a UserSession.", + "type": "object", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "HostPoolList": { + "type": "object", + "title": "HostPoolList", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPool definitions.", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "x-nullable": false + } + } + }, + "ApplicationProperties": { + "description": "Schema for Application properties.", + "type": "object", + "required": [ + "commandLineSetting" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "x-nullable": false + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "ApplicationList": { + "type": "object", + "title": "ApplicationList", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Application definitions.", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPatchProperties" + } + } + }, + "ApplicationPatchProperties": { + "description": "Application properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + } + } + }, + "Desktop": { + "description": "Schema for Desktop properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopProperties" + } + } + }, + "DesktopProperties": { + "description": "Schema for Desktop properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array." + } + } + }, + "DesktopList": { + "type": "object", + "title": "DesktopList", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Desktop definitions.", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopPatchProperties" + } + } + }, + "DesktopPatchProperties": { + "description": "Desktop properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "StartMenuItemProperties": { + "description": "Schema for StartMenuItem properties.", + "type": "object", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "description": "Index of the icon." + } + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for StartMenuItem", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StartMenuItemProperties" + } + } + }, + "StartMenuItemList": { + "type": "object", + "title": "StartMenuItemList", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of StartMenuItem definitions.", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostProperties" + } + } + }, + "SessionHostProperties": { + "description": "Schema for SessionHost properties.", + "type": "object", + "properties": { + "lastHeartBeat": { + "format": "date-time", + "type": "string", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "status": { + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "type": "string", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true + }, + "type": "string", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostPatchProperties" + } + } + }, + "SessionHostPatchProperties": { + "description": "SessionHost properties that can be patched.", + "type": "object", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + } + } + }, + "SessionHostList": { + "type": "object", + "title": "SessionHostList", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHost definitions.", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserSessionProperties" + } + } + }, + "UserSessionProperties": { + "description": "Schema for UserSession properties.", + "type": "object", + "properties": { + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Application type of application." + }, + "sessionState": { + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true + }, + "type": "string", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the user session create." + } + } + }, + "UserSessionList": { + "type": "object", + "title": "UserSessionList", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UserSession definitions.", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + } + }, + "parameters": { + "HostPoolNameParameter": { + "name": "hostPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the host pool within the specified resource group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationGroupNameParameter": { + "name": "applicationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application within the specified application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DesktopNameParameter": { + "name": "desktopName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the desktop within the specified desktop group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "SessionHostNameParameter": { + "name": "sessionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the session host within the specified host pool", + "maxLength": 48, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "UserSessionIdParameter": { + "name": "userSessionId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user session within the specified session host", + "maxLength": 24, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "StartMenuItemNameParameter": { + "name": "startMenuItemName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the start menu item within the specified host pool", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json index 1323b6f7b04c..a0e2dba51d61 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview", - "applicationGroup": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "applicationGroupType": "RemoteApp" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - }, - "201": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview", + "applicationGroup": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "applicationGroupType": "RemoteApp" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json index fe87af2b8ad1..11f7ee351ab8 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json index 823c1bb55ec6..259b54ea425b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json index 18136fe1eae9..6cc495867416 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "api-version": "2019-12-10-preview", - "$filter": "applicationGroupType eq 'RailApplication'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - { - "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-12-10-preview", + "$filter": "applicationGroupType eq 'RailApplication'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json index cb865a4a4e97..18413fe0f596 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview", - "applicationGroup": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json index 6b4a238bc273..a86d6c2ee1bf 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-12-10-preview", - "application": { - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1 - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - }, - "201": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-12-10-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json index 519b9ba4a249..4b6d78288f6c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json index 563967b99b5b..f5816590862e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json index ad1a505f987b..e12cf352859c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - { - "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des2", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json index 14cc21f094ed..b6f185cc43ed 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "applicationName": "application1", - "api-version": "2019-12-10-preview", - "application": { - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1 - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2019-12-10-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json index 9ba7029e8d05..bbb8532cc15a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "desktopName": "SessionDesktop", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", - "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json index 278df9477b0a..f33cbe712c89 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", - "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json index 8b93343fdda7..68d772f07aa7 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "desktopName": "SessionDesktop", - "api-version": "2019-12-10-preview", - "desktop": { - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", - "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2019-12-10-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "properties": { + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json index ba6d5d97f5ff..a5e9c3c789fa 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json @@ -1,94 +1,94 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-12-10-preview", - "hostPool": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "registrationInfo": { - "expirationTime": "2020-10-01T14:01:54.9571247Z", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": "KeyVaultPath", - "preferredAppGroupType": "Desktop" - } - } - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2020-10-01T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - } - }, - "201": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2020-10-01T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-12-10-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json index 434d80ce221b..9b3ff1bea24c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-12-10-preview", - "force": true - }, - "responses": { - "200": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-12-10-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json index 175c4fef704e..4ab8df265f5e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json index 302dcc34c598..3e6b26538055 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json @@ -1,72 +1,72 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - }, - { - "name": "hostPool2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json index 6ae671b69976..73f8d7272300 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json @@ -1,73 +1,73 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - }, - { - "name": "hostPool2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json index c885b024272c..4d696f7c251b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-12-10-preview", - "hostPool": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "personalDesktopAssignmentType": "Automatic", - "registrationInfo": { - "expirationTime": "2020-10-01T15:01:54.9571247Z", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": "KeyVaultPath" - } - } - }, - "responses": { - "200": { - "body": { - "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostpools", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "friendlyName": "friendly", - "description": "des1", - "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", - "customRdpProperty": null, - "maxSessionLimit": 999999, - "loadBalancerType": "BreadthFirst", - "validationEnvironment": null, - "ring": null, - "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", - "token": "token", - "registrationTokenOperation": "Update" - }, - "vmTemplate": "{json:json}", - "ssoContext": null, - "preferredAppGroupType": "Desktop" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-12-10-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": "KeyVaultPath" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoContext": null, + "preferredAppGroupType": "Desktop" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/OperationDescription_List.json index cbd7e3aa1702..0a2eddfa3310 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/OperationDescription_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/OperationDescription_List.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DesktopVirtualization/ssocontext/read", - "display": { - "provider": "Microsoft.DesktopVirtualization", - "resource": "ssocontext" - } - }, - { - "name": "Microsoft.DesktopVirtualization/ssocontext/write", - "display": { - "provider": "Microsoft.DesktopVirtualization", - "resource": "ssocontext" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/ssocontext/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "ssocontext" + } + }, + { + "name": "Microsoft.DesktopVirtualization/ssocontext/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "ssocontext" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json index 8961354c5283..a4a59da2f745 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-12-10-preview", - "force": true - }, - "responses": { - "200": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-12-10-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json index 1006aadcae10..94d0274b98d4 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json index f683f51f839e..94be122290ad 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - }, - { - "name": "sessionHost2.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost2microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user2@microsoft.com", - "status": "Available", - "statusTimestamp": "2008-09-22T14:01:54.9571247Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json index 41356917763b..8b51446575f3 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-12-10-preview", - "sessionHost": { - "properties": { - "allowNewSession": true, - "assignedUser": "user1@microsoft.com" - } - } - }, - "responses": { - "200": { - "body": { - "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", - "properties": { - "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", - "sessions": 1, - "agentVersion": "1.0.0.1391", - "allowNewSession": true, - "assignedUser": "user1@microsoft.com", - "status": "Available", - "statusTimestamp": "2019-01-24T20:00:08.2893033Z", - "osVersion": "10.0.17763", - "sxSStackVersion": "rdp-sxs190816002", - "updateState": "Succeeded", - "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "", - "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-12-10-preview", + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "properties": { + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json index fa4017a89b86..343d27392298 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "applicationGroupName": "applicationGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", - "properties": { - "appAlias": "word", - "friendlyName": "friendly", - "filePath": "/path/to/file", - "commandLineArguments": "arguments", - "iconPath": "/path/to/icon", - "iconIndex": 1 - } - }, - { - "name": "application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", - "properties": { - "appAlias": "excel", - "friendlyName": "friendly", - "filePath": "/path/to/file", - "commandLineArguments": "arguments", - "iconPath": "/path/to/icon", - "iconIndex": 1 - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "friendlyName": "friendly", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "friendlyName": "friendly", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json index ee13e7555380..de72837e8ce5 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-12-10-preview", - "force": true - }, - "responses": { - "200": { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-12-10-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Disconnect_Post.json index 001bc6529d84..8ac94b9e6aef 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Disconnect_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Disconnect_Post.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json index ad30b313730e..8068a0a55f29 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json index 771a4b13da70..3aebf00a4b86 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - }, - { - "name": "2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", - "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", - "properties": { - "userPrincipalName": "user1@microsoft.com", - "applicationType": "Desktop", - "sessionState": "Active", - "activeDirectoryUserName": "WVDARM\\user1", - "createTime": "2008-09-22T14:01:54.9571247Z" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "properties": { + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_SendMessage_Post.json index 6e7076eb9f50..de10c5e704f7 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_SendMessage_Post.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_SendMessage_Post.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "userSessionId": "1", - "api-version": "2019-12-10-preview", - "sendMessage": { - "messageTitle": "title", - "messageBody": "body" - } - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2019-12-10-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json index ff6de1e47064..715a1d0b728b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-12-10-preview", - "workspace": { - "location": "centralus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "201": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-12-10-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json index b1fac0b29d22..964e5c776111 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - }, - "204": {} - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json index 96cec1aa7acf..04cf999ff214 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json index 2988972d0e2f..3113f327f700 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "api-version": "2019-12-10-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - }, - { - "name": "workspace2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json index bd3f747371af..e00be302b70d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-12-10-preview", - "workspace": { - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - }, - "responses": { - "200": { - "body": { - "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "type": "Microsoft.DesktopVirtualization/workspaces", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2019-12-10-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/readme.csharp.md b/specification/desktopvirtualization/resource-manager/readme.csharp.md index 3fcc97028667..dced43982e18 100644 --- a/specification/desktopvirtualization/resource-manager/readme.csharp.md +++ b/specification/desktopvirtualization/resource-manager/readme.csharp.md @@ -1,15 +1,15 @@ - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DesktopVirtualization - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/DesktopVirtualization/Management.DesktopVirtualization/Generated - clear-output-folder: true -``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DesktopVirtualization + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/DesktopVirtualization/Management.DesktopVirtualization/Generated + clear-output-folder: true +``` diff --git a/specification/desktopvirtualization/resource-manager/readme.go.md b/specification/desktopvirtualization/resource-manager/readme.go.md index e01c42e568f6..8635bb42b729 100644 --- a/specification/desktopvirtualization/resource-manager/readme.go.md +++ b/specification/desktopvirtualization/resource-manager/readme.go.md @@ -1,154 +1,154 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) && !$(track2) -go: - license-header: MICROSOFT_MIT_NO_VERSION - namespace: desktopvirtualization - clear-output-folder: true -``` - -``` yaml $(go) && $(track2) -license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization -module: github.com/Azure/azure-sdk-for-go/$(module-name) -output-folder: $(go-sdk-folder)/$(module-name) -azure-arm: true -``` - -### Go multi-api -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2019-01-23-preview - - tag: package-2019-09-24-preview - - tag: package-2019-12-10-preview - - tag: package-2020-09-21-preview - - tag: package-2020-10-19-preview - - tag: package-2020-11-02-preview - - tag: package-2020-11-10-preview - - tag: package-2021-01-14-preview - - tag: package-2021-02-01-preview - - tag: package-2021-03-09-preview - - tag: package-2021-04-01-preview - - tag: package-preview-2021-09 - - tag: package-preview-2022-02 -``` - -### Tag: package-preview-2022-02 and go - -These settings apply only when `--tag=package-preview-2022-02 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-preview-2022-02' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2022-02-03-preview/$(namespace) -``` - -### Tag: package-preview-2021-09 and go - -These settings apply only when `--tag=package-preview-2021-09 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-preview-2021-09' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-09-03-preview/$(namespace) -``` - -### Tag: package-2021-04-01-preview and go - -These settings apply only when `--tag=package-2021-04-01-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2021-04-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-04-01-preview/$(namespace) -``` - -### Tag: package-2021-03-09-preview and go - -These settings apply only when `--tag=package-2021-03-09-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2021-03-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-03-09-preview/$(namespace) -``` - -### Tag: package-2021-02-01-preview and go - -These settings apply only when `--tag=package-2021-02-01-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2021-02-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-02-01-preview/$(namespace) -``` - -### Tag: package-2021-01-14-preview and go - -These settings apply only when `--tag=package-2021-01-14-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2021-01-14-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-01-14-preview/$(namespace) -``` - -### Tag: package-2020-11-10-preview and go - -These settings apply only when `--tag=package-2020-11-10-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2020-11-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-11-10-preview/$(namespace) -``` - -### Tag: package-2020-11-02-preview and go - -These settings apply only when `--tag=package-2020-11-02-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2020-11-02-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-11-02-preview/$(namespace) -``` - -### Tag: package-2020-10-19-preview and go - -These settings apply only when `--tag=package-2020-10-19-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2020-10-19-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-10-19-preview/$(namespace) -``` - -### Tag: package-2020-09-21-preview and go - -These settings apply only when `--tag=package-2020-09-21-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2020-09-21-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-09-21-preview/$(namespace) -``` - -### Tag: package-2019-12-10-preview and go - -These settings apply only when `--tag=package-2019-12-10-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2019-12-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-12-10-preview/$(namespace) -``` - -### Tag: package-2019-09-24-preview and go - -These settings apply only when `--tag=package-2019-09-24-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2019-09-24-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-09-24-preview/$(namespace) -``` - -### Tag: package-2019-01-23-preview and go - -These settings apply only when `--tag=package-2019-01-23-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2019-01-23-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-01-23-preview/$(namespace) -``` - +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && !$(track2) +go: + license-header: MICROSOFT_MIT_NO_VERSION + namespace: desktopvirtualization + clear-output-folder: true +``` + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2019-01-23-preview + - tag: package-2019-09-24-preview + - tag: package-2019-12-10-preview + - tag: package-2020-09-21-preview + - tag: package-2020-10-19-preview + - tag: package-2020-11-02-preview + - tag: package-2020-11-10-preview + - tag: package-2021-01-14-preview + - tag: package-2021-02-01-preview + - tag: package-2021-03-09-preview + - tag: package-2021-04-01-preview + - tag: package-preview-2021-09 + - tag: package-preview-2022-02 +``` + +### Tag: package-preview-2022-02 and go + +These settings apply only when `--tag=package-preview-2022-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2022-02' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2022-02-03-preview/$(namespace) +``` + +### Tag: package-preview-2021-09 and go + +These settings apply only when `--tag=package-preview-2021-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2021-09' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-09-03-preview/$(namespace) +``` + +### Tag: package-2021-04-01-preview and go + +These settings apply only when `--tag=package-2021-04-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-04-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-04-01-preview/$(namespace) +``` + +### Tag: package-2021-03-09-preview and go + +These settings apply only when `--tag=package-2021-03-09-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-03-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-03-09-preview/$(namespace) +``` + +### Tag: package-2021-02-01-preview and go + +These settings apply only when `--tag=package-2021-02-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-02-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-02-01-preview/$(namespace) +``` + +### Tag: package-2021-01-14-preview and go + +These settings apply only when `--tag=package-2021-01-14-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-01-14-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-01-14-preview/$(namespace) +``` + +### Tag: package-2020-11-10-preview and go + +These settings apply only when `--tag=package-2020-11-10-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-11-10-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-11-10-preview/$(namespace) +``` + +### Tag: package-2020-11-02-preview and go + +These settings apply only when `--tag=package-2020-11-02-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-11-02-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-11-02-preview/$(namespace) +``` + +### Tag: package-2020-10-19-preview and go + +These settings apply only when `--tag=package-2020-10-19-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-10-19-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-10-19-preview/$(namespace) +``` + +### Tag: package-2020-09-21-preview and go + +These settings apply only when `--tag=package-2020-09-21-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-09-21-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-09-21-preview/$(namespace) +``` + +### Tag: package-2019-12-10-preview and go + +These settings apply only when `--tag=package-2019-12-10-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-12-10-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-12-10-preview/$(namespace) +``` + +### Tag: package-2019-09-24-preview and go + +These settings apply only when `--tag=package-2019-09-24-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-09-24-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-09-24-preview/$(namespace) +``` + +### Tag: package-2019-01-23-preview and go + +These settings apply only when `--tag=package-2019-01-23-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-01-23-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-01-23-preview/$(namespace) +``` + diff --git a/specification/desktopvirtualization/resource-manager/readme.java.md b/specification/desktopvirtualization/resource-manager/readme.java.md index be90edf596b7..8168d6e19a0a 100644 --- a/specification/desktopvirtualization/resource-manager/readme.java.md +++ b/specification/desktopvirtualization/resource-manager/readme.java.md @@ -1,7 +1,7 @@ -## Java - -These settings apply only when `--java` is specified on the command line. - -```yaml $(java) -generate-async-methods: true -``` +## Java + +These settings apply only when `--java` is specified on the command line. + +```yaml $(java) +generate-async-methods: true +``` diff --git a/specification/desktopvirtualization/resource-manager/readme.node.md b/specification/desktopvirtualization/resource-manager/readme.node.md index bf6d3eeeb08b..2b53f1e377db 100644 --- a/specification/desktopvirtualization/resource-manager/readme.node.md +++ b/specification/desktopvirtualization/resource-manager/readme.node.md @@ -1,15 +1,15 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-mgmt-DesktopVirtualization - output-folder: $(node-sdks-folder)/lib/services/DesktopVirtualization - payload-flattening-threshold: 1 - generate-license-txt: true - generate-package-json: true - generate-readme.md: true -``` +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-mgmt-DesktopVirtualization + output-folder: $(node-sdks-folder)/lib/services/DesktopVirtualization + payload-flattening-threshold: 1 + generate-license-txt: true + generate-package-json: true + generate-readme.md: true +``` diff --git a/specification/desktopvirtualization/resource-manager/readme.python.md b/specification/desktopvirtualization/resource-manager/readme.python.md index 497a3412264c..f70993ed73dc 100644 --- a/specification/desktopvirtualization/resource-manager/readme.python.md +++ b/specification/desktopvirtualization/resource-manager/readme.python.md @@ -1,19 +1,19 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(python) -title: DesktopVirtualizationMgmtClient -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -package-name: azure-mgmt-desktopvirtualization -namespace: azure.mgmt.desktopvirtualization -package-version: 1.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/desktopvirtualization/azure-mgmt-desktopvirtualization/azure/mgmt/desktopvirtualization -``` +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +title: DesktopVirtualizationMgmtClient +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-desktopvirtualization +namespace: azure.mgmt.desktopvirtualization +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/desktopvirtualization/azure-mgmt-desktopvirtualization/azure/mgmt/desktopvirtualization +``` diff --git a/specification/desktopvirtualization/resource-manager/readme.ruby.md b/specification/desktopvirtualization/resource-manager/readme.ruby.md index 9e70e545396f..46164aa5c2ac 100644 --- a/specification/desktopvirtualization/resource-manager/readme.ruby.md +++ b/specification/desktopvirtualization/resource-manager/readme.ruby.md @@ -1,125 +1,125 @@ -## Ruby - -These settings apply only when `--ruby` is specified on the command line. - -``` yaml -package-name: azure_mgmt_desktop_virtualization -package-version: "0.16.0" -azure-arm: true -``` - -### Ruby multi-api - -``` yaml $(ruby) && $(multiapi) -batch: - - tag: package-2019-01-23-preview - - tag: package-2019-09-24-preview - - tag: package-2019-12-10-preview - - tag: package-2020-09-21-preview - - tag: package-2020-10-19-preview - - tag: package-2020-11-02-preview - - tag: package-2021-01-14-preview - - tag: package-2021-02-01-preview - - tag: package-2021-03-09-preview - - tag: package-2021-04-01-preview -``` - -### Tag: package-2021-04-01-preview and ruby - -These settings apply only when `--tag=package-2021-04-01-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-04-01-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2021_04_01_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2021-03-09-preview and ruby - -These settings apply only when `--tag=package-2021-03-09-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-03-09-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2021_03_09_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2021-02-01-preview and ruby - -These settings apply only when `--tag=package-2021-02-01-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-02-01-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2021_02_01_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2021-01-14-preview and ruby - -These settings apply only when `--tag=package-2021-01-14-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-01-14-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2021_01_14_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2020-11-02-preview and ruby - -These settings apply only when `--tag=package-2020-11-02-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-11-02-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2020_11_02_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2020-10-19-preview and ruby - -These settings apply only when `--tag=package-2020-10-19-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-10-19-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2020_10_19_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2020-09-21-preview and ruby - -These settings apply only when `--tag=package-2020-09-21-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-09-21-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2020_09_21_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2019-12-10-preview and ruby - -These settings apply only when `--tag=package-2019-12-10-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-12-10-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2019_12_10_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2019-09-24-preview and ruby - -These settings apply only when `--tag=package-2019-09-24-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-09-24-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2019_09_24_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib -``` - -### Tag: package-2019-01-23-preview and ruby - -These settings apply only when `--tag=package-2019-01-23-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2019-01-23-preview' && $(ruby) -namespace: "Azure::DesktopVirtualization::Mgmt::V2019_01_23_preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_desktop_virtualization +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2019-01-23-preview + - tag: package-2019-09-24-preview + - tag: package-2019-12-10-preview + - tag: package-2020-09-21-preview + - tag: package-2020-10-19-preview + - tag: package-2020-11-02-preview + - tag: package-2021-01-14-preview + - tag: package-2021-02-01-preview + - tag: package-2021-03-09-preview + - tag: package-2021-04-01-preview +``` + +### Tag: package-2021-04-01-preview and ruby + +These settings apply only when `--tag=package-2021-04-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-04-01-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2021_04_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2021-03-09-preview and ruby + +These settings apply only when `--tag=package-2021-03-09-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-03-09-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2021_03_09_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2021-02-01-preview and ruby + +These settings apply only when `--tag=package-2021-02-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-02-01-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2021_02_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2021-01-14-preview and ruby + +These settings apply only when `--tag=package-2021-01-14-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-01-14-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2021_01_14_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2020-11-02-preview and ruby + +These settings apply only when `--tag=package-2020-11-02-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-11-02-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2020_11_02_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2020-10-19-preview and ruby + +These settings apply only when `--tag=package-2020-10-19-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-10-19-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2020_10_19_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2020-09-21-preview and ruby + +These settings apply only when `--tag=package-2020-09-21-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-09-21-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2020_09_21_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2019-12-10-preview and ruby + +These settings apply only when `--tag=package-2019-12-10-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-12-10-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2019_12_10_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2019-09-24-preview and ruby + +These settings apply only when `--tag=package-2019-09-24-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-09-24-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2019_09_24_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib +``` + +### Tag: package-2019-01-23-preview and ruby + +These settings apply only when `--tag=package-2019-01-23-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-01-23-preview' && $(ruby) +namespace: "Azure::DesktopVirtualization::Mgmt::V2019_01_23_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_desktop_virtualization/lib ``` \ No newline at end of file diff --git a/specification/desktopvirtualization/resource-manager/readme.typescript.md b/specification/desktopvirtualization/resource-manager/readme.typescript.md index 58716fe39a3f..91873672052f 100644 --- a/specification/desktopvirtualization/resource-manager/readme.typescript.md +++ b/specification/desktopvirtualization/resource-manager/readme.typescript.md @@ -1,13 +1,13 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -``` yaml $(typescript) -typescript: - azure-arm: true - package-name: "@azure/arm-desktopvirtualization" - output-folder: "$(typescript-sdks-folder)/sdk/desktopvirtualization/arm-desktopvirtualization" - payload-flattening-threshold: 1 - generate-metadata: true -``` +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-desktopvirtualization" + output-folder: "$(typescript-sdks-folder)/sdk/desktopvirtualization/arm-desktopvirtualization" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/deviceprovisioningservices/data-plane/readme.csharp.md b/specification/deviceprovisioningservices/data-plane/readme.csharp.md index 66213f1614d7..cc68f31db1af 100644 --- a/specification/deviceprovisioningservices/data-plane/readme.csharp.md +++ b/specification/deviceprovisioningservices/data-plane/readme.csharp.md @@ -1,13 +1,13 @@ -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Devices - output-folder: $(csharp-sdks-folder)/deviceprovisioningservices/management/Microsoft.Devices/Generated - clear-output-folder: true +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Devices + output-folder: $(csharp-sdks-folder)/deviceprovisioningservices/management/Microsoft.Devices/Generated + clear-output-folder: true ``` \ No newline at end of file diff --git a/specification/deviceprovisioningservices/data-plane/readme.md b/specification/deviceprovisioningservices/data-plane/readme.md index 150bc0144c78..8ba4202a0f41 100644 --- a/specification/deviceprovisioningservices/data-plane/readme.md +++ b/specification/deviceprovisioningservices/data-plane/readme.md @@ -1,47 +1,47 @@ -# Device Provisioning Service - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Device Provisioning Service. - ---- - -## Getting Started - -To build the SDK for Device Provisioning Service, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the IotHub API. - -``` yaml -openapi-type: arm -tag: package-2021-10-01 -``` - - -### Tag: package-2021-10-01 - -These settings apply only when `--tag=package-2021-10-01` is specified on the command line. - -```yaml $(tag) == 'package-2021-10-01' -input-file: - - Microsoft.Devices/stable/2021-10-01/service.json -``` ---- - -# Code Generation - -## C# - -See configuration in [readme.csharp.md](./readme.csharp.md) +# Device Provisioning Service + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Device Provisioning Service. + +--- + +## Getting Started + +To build the SDK for Device Provisioning Service, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the IotHub API. + +``` yaml +openapi-type: arm +tag: package-2021-10-01 +``` + + +### Tag: package-2021-10-01 + +These settings apply only when `--tag=package-2021-10-01` is specified on the command line. + +```yaml $(tag) == 'package-2021-10-01' +input-file: + - Microsoft.Devices/stable/2021-10-01/service.json +``` +--- + +# Code Generation + +## C# + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateOuContainer.json index 27f8f2848212..8b5c3b0f962f 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateOuContainer.json @@ -1,100 +1,100 @@ -{ - "parameters": { - "api-version": "2017-06-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1", - "containerAccount": { - "accountName": "AccountName1", - "spn": "Spn1", - "password": "" - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2017-06-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1", + "containerAccount": { + "accountName": "AccountName1", + "spn": "Spn1", + "password": "" + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/DeleteOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/DeleteOuContainer.json index 11b98fc2c715..19f376caa40d 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/DeleteOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/DeleteOuContainer.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2017-06-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - } -} +{ + "parameters": { + "api-version": "2017-06-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/GetOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/GetOuContainer.json index c6f150bbe889..5e7653d81333 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/GetOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/GetOuContainer.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "api-version": "2017-06-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2017-06-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/ListOuContainers.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/ListOuContainers.json index 2842071473a8..52cd6b9b2876 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/ListOuContainers.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/ListOuContainers.json @@ -1,67 +1,67 @@ -{ - "parameters": { - "api-version": "2017-06-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "value": [ - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2", - "name": "OuContainer.com/OuContainer2", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer2", - "accounts": [ - { - "accountName": "AccountName3", - "spn": "Spn3" - }, - { - "accountName": "AccountName4", - "spn": "Spn4" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2017-06-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "value": [ + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2", + "name": "OuContainer.com/OuContainer2", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer2", + "accounts": [ + { + "accountName": "AccountName3", + "spn": "Spn3" + }, + { + "accountName": "AccountName4", + "spn": "Spn4" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateOuContainer.json index d7f16b63cee3..9026affa3e86 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateOuContainer.json @@ -1,72 +1,72 @@ -{ - "parameters": { - "api-version": "2017-06-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1", - "containerAccount": { - "accountName": "AccountName1", - "spn": "Spn1", - "password": "" - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2017-06-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1", + "containerAccount": { + "accountName": "AccountName1", + "spn": "Spn1", + "password": "" + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/oucontainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/oucontainer.json index 8db2f96a631f..75a0c8d9370f 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/oucontainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/oucontainer.json @@ -1,608 +1,608 @@ -{ - "swagger": "2.0", - "info": { - "title": "Domain Services Resource Provider", - "description": "The AAD Domain Services API.", - "version": "2017-06-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Aad/operations": { - "get": { - "tags": [ - "OuContainer" - ], - "description": "Lists all the available OuContainer operations.", - "operationId": "OuContainerOperations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - } - } - }, - "x-ms-examples": { - "Get Operations": { - "$ref": "./examples/GetOperations.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": { - "get": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_List", - "summary": "List of OuContainers in DomainService instance", - "description": "The List of OuContainers in DomainService instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainerListResult" - } - } - }, - "x-ms-examples": { - "List of OuContainers": { - "$ref": "./examples/ListOuContainers.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": { - "get": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Get", - "summary": "Get particular OuContainer in DomainService instance", - "description": "Get OuContainer in DomainService instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-examples": { - "List of OuContainers": { - "$ref": "./examples/GetOuContainer.json" - } - } - }, - "put": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Create", - "summary": "Create OuContainer", - "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - }, - { - "name": "containerAccount", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ContainerAccount" - }, - "description": "Container Account Description." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation completed successfully.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create Domain Service": { - "$ref": "./examples/CreateOuContainer.json" - } - } - }, - "delete": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Delete", - "summary": "Delete OuContainer", - "description": "The Delete OuContainer operation deletes specified OuContainer.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete OuContainer": { - "$ref": "./examples/DeleteOuContainer.json" - } - } - }, - "patch": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Update", - "summary": "Update OuContainer (PATCH Resource)", - "description": "The Update OuContainer operation can be used to update the existing OuContainers.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - }, - { - "name": "containerAccount", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ContainerAccount" - }, - "description": "Container Account Description." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update Domain Service": { - "$ref": "./examples/UpdateOuContainer.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "description": "The Resource model definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "etag": { - "type": "string", - "description": "Resource etag" - } - }, - "x-ms-azure-resource": true - }, - "OuContainerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OuContainer" - }, - "description": "The list of OuContainer." - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - }, - "description": "The response from the List OuContainer operation." - }, - "OuContainer": { - "description": "Resource for OuContainer.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OuContainerProperties", - "description": "OuContainer properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "OuContainerProperties": { - "description": "Properties of the OuContainer.", - "properties": { - "tenantId": { - "readOnly": true, - "type": "string", - "description": "Azure Active Directory tenant id" - }, - "domainName": { - "readOnly": true, - "type": "string", - "description": "The domain name of Domain Services." - }, - "deploymentId": { - "readOnly": true, - "type": "string", - "description": "The Deployment id" - }, - "containerId": { - "readOnly": true, - "type": "string", - "description": "The OuContainer name" - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerAccount", - "description": "Container Account" - }, - "description": "The list of container accounts" - }, - "serviceStatus": { - "readOnly": true, - "type": "string", - "description": "Status of OuContainer instance" - }, - "distinguishedName": { - "readOnly": true, - "type": "string", - "description": "Distinguished Name of OuContainer instance" - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response." - } - } - }, - "ContainerAccount": { - "description": "Container Account Description", - "properties": { - "accountName": { - "type": "string", - "description": "The account name" - }, - "spn": { - "type": "string", - "description": "The account spn" - }, - "password": { - "type": "string", - "description": "The account password" - } - } - }, - "OperationEntityListResult": { - "description": "The list of domain service operation response.", - "type": "object", - "properties": { - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - } - }, - "OperationEntity": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by Domain Services." - }, - "origin": { - "description": "The origin of the operation.", - "type": "string" - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Domain Services.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "description": "An error response from the Domain Services.", - "$ref": "#/definitions/CloudErrorBody" - } - }, - "description": "An error response from the Domain Services." - }, - "CloudErrorBody": { - "x-ms-external": true, - "properties": { - "code": { - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Domain Services." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "DomainServiceNameParameter": { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service.", - "x-ms-parameter-location": "method" - }, - "OuContainerNameParameter": { - "name": "ouContainerName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the OuContainer.", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Domain Services Resource Provider", + "description": "The AAD Domain Services API.", + "version": "2017-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Aad/operations": { + "get": { + "tags": [ + "OuContainer" + ], + "description": "Lists all the available OuContainer operations.", + "operationId": "OuContainerOperations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": { + "get": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_List", + "summary": "List of OuContainers in DomainService instance", + "description": "The List of OuContainers in DomainService instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainerListResult" + } + } + }, + "x-ms-examples": { + "List of OuContainers": { + "$ref": "./examples/ListOuContainers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": { + "get": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Get", + "summary": "Get particular OuContainer in DomainService instance", + "description": "Get OuContainer in DomainService instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-examples": { + "List of OuContainers": { + "$ref": "./examples/GetOuContainer.json" + } + } + }, + "put": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Create", + "summary": "Create OuContainer", + "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + }, + { + "name": "containerAccount", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerAccount" + }, + "description": "Container Account Description." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation completed successfully.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Domain Service": { + "$ref": "./examples/CreateOuContainer.json" + } + } + }, + "delete": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Delete", + "summary": "Delete OuContainer", + "description": "The Delete OuContainer operation deletes specified OuContainer.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete OuContainer": { + "$ref": "./examples/DeleteOuContainer.json" + } + } + }, + "patch": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Update", + "summary": "Update OuContainer (PATCH Resource)", + "description": "The Update OuContainer operation can be used to update the existing OuContainers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + }, + { + "name": "containerAccount", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerAccount" + }, + "description": "Container Account Description." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Domain Service": { + "$ref": "./examples/UpdateOuContainer.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "Resource etag" + } + }, + "x-ms-azure-resource": true + }, + "OuContainerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OuContainer" + }, + "description": "The list of OuContainer." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response from the List OuContainer operation." + }, + "OuContainer": { + "description": "Resource for OuContainer.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OuContainerProperties", + "description": "OuContainer properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "OuContainerProperties": { + "description": "Properties of the OuContainer.", + "properties": { + "tenantId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory tenant id" + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "The domain name of Domain Services." + }, + "deploymentId": { + "readOnly": true, + "type": "string", + "description": "The Deployment id" + }, + "containerId": { + "readOnly": true, + "type": "string", + "description": "The OuContainer name" + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAccount", + "description": "Container Account" + }, + "description": "The list of container accounts" + }, + "serviceStatus": { + "readOnly": true, + "type": "string", + "description": "Status of OuContainer instance" + }, + "distinguishedName": { + "readOnly": true, + "type": "string", + "description": "Distinguished Name of OuContainer instance" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ContainerAccount": { + "description": "Container Account Description", + "properties": { + "accountName": { + "type": "string", + "description": "The account name" + }, + "spn": { + "type": "string", + "description": "The account spn" + }, + "password": { + "type": "string", + "description": "The account password" + } + } + }, + "OperationEntityListResult": { + "description": "The list of domain service operation response.", + "type": "object", + "properties": { + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + } + }, + "OperationEntity": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Domain Services." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Domain Services.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "An error response from the Domain Services.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Domain Services." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Domain Services." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "DomainServiceNameParameter": { + "name": "domainServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the domain service.", + "x-ms-parameter-location": "method" + }, + "OuContainerNameParameter": { + "name": "ouContainerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the OuContainer.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/CreateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/CreateOuContainer.json index b1f755ea63f8..9e85e41659d7 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/CreateOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/CreateOuContainer.json @@ -1,100 +1,100 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1", - "containerAccount": { - "accountName": "AccountName1", - "spn": "Spn1", - "password": "" - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1", + "containerAccount": { + "accountName": "AccountName1", + "spn": "Spn1", + "password": "" + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/DeleteOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/DeleteOuContainer.json index ab7dec2f11de..742a4cddcd75 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/DeleteOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/DeleteOuContainer.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - } -} +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/GetOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/GetOuContainer.json index 90b57878c52d..2eaf4c27e30f 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/GetOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/GetOuContainer.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/ListOuContainers.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/ListOuContainers.json index 0153c95e3fed..0e2ea64f414d 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/ListOuContainers.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/ListOuContainers.json @@ -1,67 +1,67 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "value": [ - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2", - "name": "OuContainer.com/OuContainer2", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer2", - "accounts": [ - { - "accountName": "AccountName3", - "spn": "Spn3" - }, - { - "accountName": "AccountName4", - "spn": "Spn4" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "value": [ + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2", + "name": "OuContainer.com/OuContainer2", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer2", + "accounts": [ + { + "accountName": "AccountName3", + "spn": "Spn3" + }, + { + "accountName": "AccountName4", + "spn": "Spn4" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/UpdateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/UpdateOuContainer.json index 4dd5262f3dc9..c1b2ca565201 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/UpdateOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/examples/UpdateOuContainer.json @@ -1,72 +1,72 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1", - "containerAccount": { - "accountName": "AccountName1", - "spn": "Spn1", - "password": "" - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "location": "westus", - "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1", + "containerAccount": { + "accountName": "AccountName1", + "spn": "Spn1", + "password": "" + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "location": "westus", + "etag": "W/\"datetime'2017-04-10T04%3A42%3A19.7067387Z'\"", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/oucontainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/oucontainer.json index c61923ab2617..1e1f27c3ef82 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/oucontainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/oucontainer.json @@ -1,608 +1,608 @@ -{ - "swagger": "2.0", - "info": { - "title": "Domain Services Resource Provider", - "description": "The AAD Domain Services API.", - "version": "2020-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Aad/operations": { - "get": { - "tags": [ - "OuContainer" - ], - "description": "Lists all the available OuContainer operations.", - "operationId": "OuContainerOperations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - } - } - }, - "x-ms-examples": { - "Get Operations": { - "$ref": "./examples/GetOperations.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": { - "get": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_List", - "summary": "List of OuContainers in DomainService instance", - "description": "The List of OuContainers in DomainService instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainerListResult" - } - } - }, - "x-ms-examples": { - "List of OuContainers": { - "$ref": "./examples/ListOuContainers.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": { - "get": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Get", - "summary": "Get particular OuContainer in DomainService instance", - "description": "Get OuContainer in DomainService instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-examples": { - "List of OuContainers": { - "$ref": "./examples/GetOuContainer.json" - } - } - }, - "put": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Create", - "summary": "Create OuContainer", - "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - }, - { - "name": "containerAccount", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ContainerAccount" - }, - "description": "Container Account Description." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation completed successfully.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create Domain Service": { - "$ref": "./examples/CreateOuContainer.json" - } - } - }, - "delete": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Delete", - "summary": "Delete OuContainer", - "description": "The Delete OuContainer operation deletes specified OuContainer.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete OuContainer": { - "$ref": "./examples/DeleteOuContainer.json" - } - } - }, - "patch": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Update", - "summary": "Update OuContainer (PATCH Resource)", - "description": "The Update OuContainer operation can be used to update the existing OuContainers.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - }, - { - "name": "containerAccount", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ContainerAccount" - }, - "description": "Container Account Description." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update Domain Service": { - "$ref": "./examples/UpdateOuContainer.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "description": "The Resource model definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "etag": { - "type": "string", - "description": "Resource etag" - } - }, - "x-ms-azure-resource": true - }, - "OuContainerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OuContainer" - }, - "description": "The list of OuContainer." - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - }, - "description": "The response from the List OuContainer operation." - }, - "OuContainer": { - "description": "Resource for OuContainer.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OuContainerProperties", - "description": "OuContainer properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "OuContainerProperties": { - "description": "Properties of the OuContainer.", - "properties": { - "tenantId": { - "readOnly": true, - "type": "string", - "description": "Azure Active Directory tenant id" - }, - "domainName": { - "readOnly": true, - "type": "string", - "description": "The domain name of Domain Services." - }, - "deploymentId": { - "readOnly": true, - "type": "string", - "description": "The Deployment id" - }, - "containerId": { - "readOnly": true, - "type": "string", - "description": "The OuContainer name" - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerAccount", - "description": "Container Account" - }, - "description": "The list of container accounts" - }, - "serviceStatus": { - "readOnly": true, - "type": "string", - "description": "Status of OuContainer instance" - }, - "distinguishedName": { - "readOnly": true, - "type": "string", - "description": "Distinguished Name of OuContainer instance" - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response." - } - } - }, - "ContainerAccount": { - "description": "Container Account Description", - "properties": { - "accountName": { - "type": "string", - "description": "The account name" - }, - "spn": { - "type": "string", - "description": "The account spn" - }, - "password": { - "type": "string", - "description": "The account password" - } - } - }, - "OperationEntityListResult": { - "description": "The list of domain service operation response.", - "type": "object", - "properties": { - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - } - }, - "OperationEntity": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by Domain Services." - }, - "origin": { - "description": "The origin of the operation.", - "type": "string" - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Domain Services.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "description": "An error response from the Domain Services.", - "$ref": "#/definitions/CloudErrorBody" - } - }, - "description": "An error response from the Domain Services." - }, - "CloudErrorBody": { - "x-ms-external": true, - "properties": { - "code": { - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Domain Services." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "DomainServiceNameParameter": { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service.", - "x-ms-parameter-location": "method" - }, - "OuContainerNameParameter": { - "name": "ouContainerName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the OuContainer.", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Domain Services Resource Provider", + "description": "The AAD Domain Services API.", + "version": "2020-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Aad/operations": { + "get": { + "tags": [ + "OuContainer" + ], + "description": "Lists all the available OuContainer operations.", + "operationId": "OuContainerOperations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": { + "get": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_List", + "summary": "List of OuContainers in DomainService instance", + "description": "The List of OuContainers in DomainService instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainerListResult" + } + } + }, + "x-ms-examples": { + "List of OuContainers": { + "$ref": "./examples/ListOuContainers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": { + "get": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Get", + "summary": "Get particular OuContainer in DomainService instance", + "description": "Get OuContainer in DomainService instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-examples": { + "List of OuContainers": { + "$ref": "./examples/GetOuContainer.json" + } + } + }, + "put": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Create", + "summary": "Create OuContainer", + "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + }, + { + "name": "containerAccount", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerAccount" + }, + "description": "Container Account Description." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation completed successfully.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Domain Service": { + "$ref": "./examples/CreateOuContainer.json" + } + } + }, + "delete": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Delete", + "summary": "Delete OuContainer", + "description": "The Delete OuContainer operation deletes specified OuContainer.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete OuContainer": { + "$ref": "./examples/DeleteOuContainer.json" + } + } + }, + "patch": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Update", + "summary": "Update OuContainer (PATCH Resource)", + "description": "The Update OuContainer operation can be used to update the existing OuContainers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + }, + { + "name": "containerAccount", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerAccount" + }, + "description": "Container Account Description." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Domain Service": { + "$ref": "./examples/UpdateOuContainer.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "Resource etag" + } + }, + "x-ms-azure-resource": true + }, + "OuContainerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OuContainer" + }, + "description": "The list of OuContainer." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response from the List OuContainer operation." + }, + "OuContainer": { + "description": "Resource for OuContainer.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OuContainerProperties", + "description": "OuContainer properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "OuContainerProperties": { + "description": "Properties of the OuContainer.", + "properties": { + "tenantId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory tenant id" + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "The domain name of Domain Services." + }, + "deploymentId": { + "readOnly": true, + "type": "string", + "description": "The Deployment id" + }, + "containerId": { + "readOnly": true, + "type": "string", + "description": "The OuContainer name" + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAccount", + "description": "Container Account" + }, + "description": "The list of container accounts" + }, + "serviceStatus": { + "readOnly": true, + "type": "string", + "description": "Status of OuContainer instance" + }, + "distinguishedName": { + "readOnly": true, + "type": "string", + "description": "Distinguished Name of OuContainer instance" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ContainerAccount": { + "description": "Container Account Description", + "properties": { + "accountName": { + "type": "string", + "description": "The account name" + }, + "spn": { + "type": "string", + "description": "The account spn" + }, + "password": { + "type": "string", + "description": "The account password" + } + } + }, + "OperationEntityListResult": { + "description": "The list of domain service operation response.", + "type": "object", + "properties": { + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + } + }, + "OperationEntity": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Domain Services." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Domain Services.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "An error response from the Domain Services.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Domain Services." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Domain Services." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "DomainServiceNameParameter": { + "name": "domainServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the domain service.", + "x-ms-parameter-location": "method" + }, + "OuContainerNameParameter": { + "name": "ouContainerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the OuContainer.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/domainservices.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/domainservices.json index 95068505ec49..4117c3dd19dd 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/domainservices.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/domainservices.json @@ -1,1038 +1,1038 @@ -{ - "swagger": "2.0", - "info": { - "title": "Domain Services Resource Provider", - "description": "The AAD Domain Services API.", - "version": "2021-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.AAD/operations": { - "get": { - "tags": [ - "DomainServices" - ], - "description": "Lists all the available Domain Services operations.", - "operationId": "DomainServiceOperations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get Operations": { - "$ref": "./examples/GetOperations.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices": { - "get": { - "tags": [ - "DomainServices" - ], - "operationId": "DomainServices_List", - "summary": "List Domain Services in Subscription", - "description": "The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/DomainServiceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "List Domain Service": { - "$ref": "./examples/ListDomainServicesBySubscription.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices": { - "get": { - "tags": [ - "DomainServices" - ], - "operationId": "DomainServices_ListByResourceGroup", - "summary": "List Domain Services in Resource Group", - "description": "The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/DomainServiceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "List Domain Service": { - "$ref": "./examples/ListDomainServicesByResourceGroup.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}": { - "put": { - "tags": [ - "DomainServices" - ], - "operationId": "DomainServices_CreateOrUpdate", - "summary": "Create or Update Domain Service (PUT Resource)", - "description": "The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "name": "domainService", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DomainService" - }, - "description": "Properties supplied to the Create or Update a Domain Service operation." - } - ], - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/DomainService" - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation completed successfully.", - "schema": { - "$ref": "#/definitions/DomainService" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/DomainService" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create Domain Service": { - "$ref": "./examples/CreateDomainService.json" - } - } - }, - "get": { - "tags": [ - "DomainServices" - ], - "operationId": "DomainServices_Get", - "summary": "Get Domain Service", - "description": "The Get Domain Service operation retrieves a json representation of the Domain Service.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - } - ], - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/DomainService" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get Domain Service": { - "$ref": "./examples/GetDomainService.json" - } - } - }, - "delete": { - "tags": [ - "DomainServices" - ], - "operationId": "DomainServices_Delete", - "summary": "Delete Domain Service (DELETE Resource)", - "description": "The Delete Domain Service operation deletes an existing Domain Service.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - } - ], - "responses": { - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete Domain Service": { - "$ref": "./examples/DeleteDomainService.json" - } - } - }, - "patch": { - "tags": [ - "DomainServices" - ], - "operationId": "DomainServices_Update", - "summary": "Update Domain Service (PATCH Resource)", - "description": "The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "name": "domainService", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DomainService" - }, - "description": "Properties supplied to the Update a Domain Service operation." - } - ], - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/DomainService" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/DomainService" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update Domain Service": { - "$ref": "./examples/UpdateDomainService.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "description": "The Resource model definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "etag": { - "type": "string", - "description": "Resource etag" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "x-ms-azure-resource": true - }, - "DomainService": { - "description": "Domain service.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DomainServiceProperties", - "description": "Domain service properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "DomainServiceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DomainService" - }, - "description": "the list of domain services." - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - }, - "description": "The response from the List Domain Services operation." - }, - "DomainServiceProperties": { - "description": "Properties of the Domain Service.", - "properties": { - "version": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Data Model Version" - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "Azure Active Directory Tenant Id" - }, - "domainName": { - "type": "string", - "description": "The name of the Azure domain that the user would like to deploy Domain Services to." - }, - "deploymentId": { - "readOnly": true, - "type": "string", - "description": "Deployment Id" - }, - "syncOwner": { - "readOnly": true, - "type": "string", - "description": "SyncOwner ReplicaSet Id" - }, - "replicaSets": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaSet", - "description": "ReplicaSet" - }, - "description": "List of ReplicaSets" - }, - "ldapsSettings": { - "$ref": "#/definitions/LdapsSettings", - "description": "Secure LDAP Settings" - }, - "resourceForestSettings": { - "$ref": "#/definitions/ResourceForestSettings", - "description": "Resource Forest Settings" - }, - "domainSecuritySettings": { - "$ref": "#/definitions/DomainSecuritySettings", - "description": "DomainSecurity Settings" - }, - "domainConfigurationType": { - "type": "string", - "description": "Domain Configuration Type" - }, - "sku": { - "type": "string", - "description": "Sku Type" - }, - "filteredSync": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "description": "Enabled or Disabled flag to turn on Group-based filtered sync", - "x-ms-enum": { - "name": "FilteredSync", - "modelAsString": true - } - }, - "notificationSettings": { - "$ref": "#/definitions/NotificationSettings", - "description": "Notification Settings" - }, - "migrationProperties": { - "readOnly": true, - "$ref": "#/definitions/MigrationProperties", - "description": "Migration Properties" - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "the current deployment or provisioning state, which only appears in the response." - } - } - }, - "ReplicaSet": { - "description": "Replica Set Definition", - "properties": { - "replicaSetId": { - "readOnly": true, - "type": "string", - "description": "ReplicaSet Id" - }, - "location": { - "type": "string", - "description": "Virtual network location" - }, - "vnetSiteId": { - "readOnly": true, - "type": "string", - "description": "Virtual network site id" - }, - "subnetId": { - "type": "string", - "description": "The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName." - }, - "domainControllerIpAddress": { - "readOnly": true, - "type": "array", - "items": { - "type": "string", - "description": "Domain Controller IP Address" - }, - "description": "List of Domain Controller IP Address" - }, - "externalAccessIpAddress": { - "readOnly": true, - "type": "string", - "description": "External access ip address." - }, - "serviceStatus": { - "readOnly": true, - "type": "string", - "description": "Status of Domain Service instance" - }, - "healthLastEvaluated": { - "readOnly": true, - "type": "string", - "format": "date-time-rfc1123", - "description": "Last domain evaluation run DateTime" - }, - "healthMonitors": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/HealthMonitor", - "description": "Domain Health Monitors" - }, - "description": "List of Domain Health Monitors" - }, - "healthAlerts": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/HealthAlert", - "description": "Domain Health Alerts" - }, - "description": "List of Domain Health Alerts" - } - } - }, - "LdapsSettings": { - "description": "Secure LDAP Settings", - "properties": { - "ldaps": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Disabled", - "description": "A flag to determine whether or not Secure LDAP is enabled or disabled.", - "x-ms-enum": { - "name": "Ldaps", - "modelAsString": true - } - }, - "pfxCertificate": { - "type": "string", - "description": "The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file." - }, - "pfxCertificatePassword": { - "type": "string", - "description": "The password to decrypt the provided Secure LDAP certificate pfx file." - }, - "publicCertificate": { - "readOnly": true, - "type": "string", - "description": "Public certificate used to configure secure ldap." - }, - "certificateThumbprint": { - "readOnly": true, - "type": "string", - "description": "Thumbprint of configure ldaps certificate." - }, - "certificateNotAfter": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "NotAfter DateTime of configure ldaps certificate." - }, - "externalAccess": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Disabled", - "description": "A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.", - "x-ms-enum": { - "name": "ExternalAccess", - "modelAsString": true - } - } - } - }, - "HealthMonitor": { - "description": "Health Monitor Description", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Health Monitor Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Health Monitor Name" - }, - "details": { - "readOnly": true, - "type": "string", - "description": "Health Monitor Details" - } - } - }, - "HealthAlert": { - "description": "Health Alert Description", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Health Alert Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Health Alert Name" - }, - "issue": { - "readOnly": true, - "type": "string", - "description": "Health Alert Issue" - }, - "severity": { - "readOnly": true, - "type": "string", - "description": "Health Alert Severity" - }, - "raised": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Health Alert Raised DateTime" - }, - "lastDetected": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Health Alert Last Detected DateTime" - }, - "resolutionUri": { - "readOnly": true, - "type": "string", - "description": "Health Alert TSG Link" - } - } - }, - "NotificationSettings": { - "description": "Settings for notification", - "properties": { - "notifyGlobalAdmins": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "description": "Should global admins be notified", - "x-ms-enum": { - "name": "notifyGlobalAdmins", - "modelAsString": true - } - }, - "notifyDcAdmins": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "description": "Should domain controller admins be notified", - "x-ms-enum": { - "name": "notifyDcAdmins", - "modelAsString": true - } - }, - "additionalRecipients": { - "type": "array", - "items": { - "type": "string", - "description": "Email address for additional recipient" - }, - "description": "The list of additional recipients" - } - } - }, - "ResourceForestSettings": { - "description": "Settings for Resource Forest", - "properties": { - "settings": { - "type": "array", - "items": { - "$ref": "#/definitions/ForestTrust" - }, - "description": "List of settings for Resource Forest" - }, - "resourceForest": { - "type": "string", - "description": "Resource Forest" - } - } - }, - "ForestTrust": { - "description": "Forest Trust Setting", - "properties": { - "trustedDomainFqdn": { - "type": "string", - "description": "Trusted Domain FQDN" - }, - "trustDirection": { - "type": "string", - "description": "Trust Direction" - }, - "friendlyName": { - "type": "string", - "description": "Friendly Name" - }, - "remoteDnsIps": { - "type": "string", - "description": "Remote Dns ips" - }, - "trustPassword": { - "type": "string", - "description": "Trust Password", - "x-ms-secret": true - } - } - }, - "MigrationProperties": { - "description": "Migration Properties", - "properties": { - "oldSubnetId": { - "readOnly": true, - "type": "string", - "description": "Old Subnet Id" - }, - "oldVnetSiteId": { - "readOnly": true, - "type": "string", - "description": "Old Vnet Site Id" - }, - "migrationProgress": { - "readOnly": true, - "$ref": "#/definitions/MigrationProgress", - "description": "Migration Progress" - } - } - }, - "MigrationProgress": { - "description": "Migration Progress", - "properties": { - "completionPercentage": { - "type": "number", - "format": "double", - "description": "Completion Percentage" - }, - "progressMessage": { - "type": "string", - "description": "Progress Message" - } - } - }, - "DomainSecuritySettings": { - "description": "Domain Security Settings", - "properties": { - "ntlmV1": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "description": "A flag to determine whether or not NtlmV1 is enabled or disabled.", - "x-ms-enum": { - "name": "NtlmV1", - "modelAsString": true - } - }, - "tlsV1": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "description": "A flag to determine whether or not TlsV1 is enabled or disabled.", - "x-ms-enum": { - "name": "TlsV1", - "modelAsString": true - } - }, - "syncNtlmPasswords": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "description": "A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.", - "x-ms-enum": { - "name": "SyncNtlmPasswords", - "modelAsString": true - } - }, - "syncKerberosPasswords": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "description": "A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.", - "x-ms-enum": { - "name": "SyncKerberosPasswords", - "modelAsString": true - } - }, - "syncOnPremPasswords": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "description": "A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.", - "x-ms-enum": { - "name": "SyncOnPremPasswords", - "modelAsString": true - } - }, - "kerberosRc4Encryption": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "description": "A flag to determine whether or not KerberosRc4Encryption is enabled or disabled.", - "x-ms-enum": { - "name": "KerberosRc4Encryption", - "modelAsString": true - } - }, - "kerberosArmoring": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Disabled", - "description": "A flag to determine whether or not KerberosArmoring is enabled or disabled.", - "x-ms-enum": { - "name": "KerberosArmoring", - "modelAsString": true - } - } - } - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "description": "An error response from the Domain Services.", - "$ref": "#/definitions/CloudErrorBody" - } - }, - "description": "An error response from the Domain Services." - }, - "CloudErrorBody": { - "x-ms-external": true, - "properties": { - "code": { - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Domain Services." - }, - "OperationEntityListResult": { - "description": "The list of domain service operation response.", - "type": "object", - "properties": { - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - } - }, - "OperationEntity": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by Domain Services." - }, - "origin": { - "description": "The origin of the operation.", - "type": "string" - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Domain Services.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "DomainServiceNameParameter": { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service.", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Domain Services Resource Provider", + "description": "The AAD Domain Services API.", + "version": "2021-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AAD/operations": { + "get": { + "tags": [ + "DomainServices" + ], + "description": "Lists all the available Domain Services operations.", + "operationId": "DomainServiceOperations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices": { + "get": { + "tags": [ + "DomainServices" + ], + "operationId": "DomainServices_List", + "summary": "List Domain Services in Subscription", + "description": "The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/DomainServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Domain Service": { + "$ref": "./examples/ListDomainServicesBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices": { + "get": { + "tags": [ + "DomainServices" + ], + "operationId": "DomainServices_ListByResourceGroup", + "summary": "List Domain Services in Resource Group", + "description": "The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/DomainServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Domain Service": { + "$ref": "./examples/ListDomainServicesByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}": { + "put": { + "tags": [ + "DomainServices" + ], + "operationId": "DomainServices_CreateOrUpdate", + "summary": "Create or Update Domain Service (PUT Resource)", + "description": "The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "name": "domainService", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DomainService" + }, + "description": "Properties supplied to the Create or Update a Domain Service operation." + } + ], + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/DomainService" + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation completed successfully.", + "schema": { + "$ref": "#/definitions/DomainService" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DomainService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Domain Service": { + "$ref": "./examples/CreateDomainService.json" + } + } + }, + "get": { + "tags": [ + "DomainServices" + ], + "operationId": "DomainServices_Get", + "summary": "Get Domain Service", + "description": "The Get Domain Service operation retrieves a json representation of the Domain Service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/DomainService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Domain Service": { + "$ref": "./examples/GetDomainService.json" + } + } + }, + "delete": { + "tags": [ + "DomainServices" + ], + "operationId": "DomainServices_Delete", + "summary": "Delete Domain Service (DELETE Resource)", + "description": "The Delete Domain Service operation deletes an existing Domain Service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + } + ], + "responses": { + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Domain Service": { + "$ref": "./examples/DeleteDomainService.json" + } + } + }, + "patch": { + "tags": [ + "DomainServices" + ], + "operationId": "DomainServices_Update", + "summary": "Update Domain Service (PATCH Resource)", + "description": "The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "name": "domainService", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DomainService" + }, + "description": "Properties supplied to the Update a Domain Service operation." + } + ], + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/DomainService" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DomainService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Domain Service": { + "$ref": "./examples/UpdateDomainService.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "Resource etag" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "DomainService": { + "description": "Domain service.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DomainServiceProperties", + "description": "Domain service properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "DomainServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DomainService" + }, + "description": "the list of domain services." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response from the List Domain Services operation." + }, + "DomainServiceProperties": { + "description": "Properties of the Domain Service.", + "properties": { + "version": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Data Model Version" + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory Tenant Id" + }, + "domainName": { + "type": "string", + "description": "The name of the Azure domain that the user would like to deploy Domain Services to." + }, + "deploymentId": { + "readOnly": true, + "type": "string", + "description": "Deployment Id" + }, + "syncOwner": { + "readOnly": true, + "type": "string", + "description": "SyncOwner ReplicaSet Id" + }, + "replicaSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaSet", + "description": "ReplicaSet" + }, + "description": "List of ReplicaSets" + }, + "ldapsSettings": { + "$ref": "#/definitions/LdapsSettings", + "description": "Secure LDAP Settings" + }, + "resourceForestSettings": { + "$ref": "#/definitions/ResourceForestSettings", + "description": "Resource Forest Settings" + }, + "domainSecuritySettings": { + "$ref": "#/definitions/DomainSecuritySettings", + "description": "DomainSecurity Settings" + }, + "domainConfigurationType": { + "type": "string", + "description": "Domain Configuration Type" + }, + "sku": { + "type": "string", + "description": "Sku Type" + }, + "filteredSync": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Enabled or Disabled flag to turn on Group-based filtered sync", + "x-ms-enum": { + "name": "FilteredSync", + "modelAsString": true + } + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettings", + "description": "Notification Settings" + }, + "migrationProperties": { + "readOnly": true, + "$ref": "#/definitions/MigrationProperties", + "description": "Migration Properties" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "the current deployment or provisioning state, which only appears in the response." + } + } + }, + "ReplicaSet": { + "description": "Replica Set Definition", + "properties": { + "replicaSetId": { + "readOnly": true, + "type": "string", + "description": "ReplicaSet Id" + }, + "location": { + "type": "string", + "description": "Virtual network location" + }, + "vnetSiteId": { + "readOnly": true, + "type": "string", + "description": "Virtual network site id" + }, + "subnetId": { + "type": "string", + "description": "The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName." + }, + "domainControllerIpAddress": { + "readOnly": true, + "type": "array", + "items": { + "type": "string", + "description": "Domain Controller IP Address" + }, + "description": "List of Domain Controller IP Address" + }, + "externalAccessIpAddress": { + "readOnly": true, + "type": "string", + "description": "External access ip address." + }, + "serviceStatus": { + "readOnly": true, + "type": "string", + "description": "Status of Domain Service instance" + }, + "healthLastEvaluated": { + "readOnly": true, + "type": "string", + "format": "date-time-rfc1123", + "description": "Last domain evaluation run DateTime" + }, + "healthMonitors": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/HealthMonitor", + "description": "Domain Health Monitors" + }, + "description": "List of Domain Health Monitors" + }, + "healthAlerts": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/HealthAlert", + "description": "Domain Health Alerts" + }, + "description": "List of Domain Health Alerts" + } + } + }, + "LdapsSettings": { + "description": "Secure LDAP Settings", + "properties": { + "ldaps": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Disabled", + "description": "A flag to determine whether or not Secure LDAP is enabled or disabled.", + "x-ms-enum": { + "name": "Ldaps", + "modelAsString": true + } + }, + "pfxCertificate": { + "type": "string", + "description": "The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file." + }, + "pfxCertificatePassword": { + "type": "string", + "description": "The password to decrypt the provided Secure LDAP certificate pfx file." + }, + "publicCertificate": { + "readOnly": true, + "type": "string", + "description": "Public certificate used to configure secure ldap." + }, + "certificateThumbprint": { + "readOnly": true, + "type": "string", + "description": "Thumbprint of configure ldaps certificate." + }, + "certificateNotAfter": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "NotAfter DateTime of configure ldaps certificate." + }, + "externalAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Disabled", + "description": "A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.", + "x-ms-enum": { + "name": "ExternalAccess", + "modelAsString": true + } + } + } + }, + "HealthMonitor": { + "description": "Health Monitor Description", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Health Monitor Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Health Monitor Name" + }, + "details": { + "readOnly": true, + "type": "string", + "description": "Health Monitor Details" + } + } + }, + "HealthAlert": { + "description": "Health Alert Description", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Health Alert Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Health Alert Name" + }, + "issue": { + "readOnly": true, + "type": "string", + "description": "Health Alert Issue" + }, + "severity": { + "readOnly": true, + "type": "string", + "description": "Health Alert Severity" + }, + "raised": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Health Alert Raised DateTime" + }, + "lastDetected": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Health Alert Last Detected DateTime" + }, + "resolutionUri": { + "readOnly": true, + "type": "string", + "description": "Health Alert TSG Link" + } + } + }, + "NotificationSettings": { + "description": "Settings for notification", + "properties": { + "notifyGlobalAdmins": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Should global admins be notified", + "x-ms-enum": { + "name": "notifyGlobalAdmins", + "modelAsString": true + } + }, + "notifyDcAdmins": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Should domain controller admins be notified", + "x-ms-enum": { + "name": "notifyDcAdmins", + "modelAsString": true + } + }, + "additionalRecipients": { + "type": "array", + "items": { + "type": "string", + "description": "Email address for additional recipient" + }, + "description": "The list of additional recipients" + } + } + }, + "ResourceForestSettings": { + "description": "Settings for Resource Forest", + "properties": { + "settings": { + "type": "array", + "items": { + "$ref": "#/definitions/ForestTrust" + }, + "description": "List of settings for Resource Forest" + }, + "resourceForest": { + "type": "string", + "description": "Resource Forest" + } + } + }, + "ForestTrust": { + "description": "Forest Trust Setting", + "properties": { + "trustedDomainFqdn": { + "type": "string", + "description": "Trusted Domain FQDN" + }, + "trustDirection": { + "type": "string", + "description": "Trust Direction" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "remoteDnsIps": { + "type": "string", + "description": "Remote Dns ips" + }, + "trustPassword": { + "type": "string", + "description": "Trust Password", + "x-ms-secret": true + } + } + }, + "MigrationProperties": { + "description": "Migration Properties", + "properties": { + "oldSubnetId": { + "readOnly": true, + "type": "string", + "description": "Old Subnet Id" + }, + "oldVnetSiteId": { + "readOnly": true, + "type": "string", + "description": "Old Vnet Site Id" + }, + "migrationProgress": { + "readOnly": true, + "$ref": "#/definitions/MigrationProgress", + "description": "Migration Progress" + } + } + }, + "MigrationProgress": { + "description": "Migration Progress", + "properties": { + "completionPercentage": { + "type": "number", + "format": "double", + "description": "Completion Percentage" + }, + "progressMessage": { + "type": "string", + "description": "Progress Message" + } + } + }, + "DomainSecuritySettings": { + "description": "Domain Security Settings", + "properties": { + "ntlmV1": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "A flag to determine whether or not NtlmV1 is enabled or disabled.", + "x-ms-enum": { + "name": "NtlmV1", + "modelAsString": true + } + }, + "tlsV1": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "A flag to determine whether or not TlsV1 is enabled or disabled.", + "x-ms-enum": { + "name": "TlsV1", + "modelAsString": true + } + }, + "syncNtlmPasswords": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.", + "x-ms-enum": { + "name": "SyncNtlmPasswords", + "modelAsString": true + } + }, + "syncKerberosPasswords": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.", + "x-ms-enum": { + "name": "SyncKerberosPasswords", + "modelAsString": true + } + }, + "syncOnPremPasswords": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.", + "x-ms-enum": { + "name": "SyncOnPremPasswords", + "modelAsString": true + } + }, + "kerberosRc4Encryption": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "A flag to determine whether or not KerberosRc4Encryption is enabled or disabled.", + "x-ms-enum": { + "name": "KerberosRc4Encryption", + "modelAsString": true + } + }, + "kerberosArmoring": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Disabled", + "description": "A flag to determine whether or not KerberosArmoring is enabled or disabled.", + "x-ms-enum": { + "name": "KerberosArmoring", + "modelAsString": true + } + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "An error response from the Domain Services.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Domain Services." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Domain Services." + }, + "OperationEntityListResult": { + "description": "The list of domain service operation response.", + "type": "object", + "properties": { + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + } + }, + "OperationEntity": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Domain Services." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Domain Services.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "DomainServiceNameParameter": { + "name": "domainServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the domain service.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateDomainService.json index d379ae5471d4..ff0238a0dcae 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateDomainService.json @@ -1,181 +1,181 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "TestResourceGroup", - "domainServiceName": "TestDomainService.com", - "domainService": { - "properties": { - "domainName": "TestDomainService.com", - "replicaSets": [ - { - "location": "West US", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "pfxCertificatePassword": "", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - } - } - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "externalAccessIpAddress": "13.64.148.151", - "serviceStatus": "Running" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation completed successfully.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "externalAccessIpAddress": "13.64.148.151", - "serviceStatus": "Running" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "replicaSets": [ - { - "location": "West US", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Accepted" - } - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "TestResourceGroup", + "domainServiceName": "TestDomainService.com", + "domainService": { + "properties": { + "domainName": "TestDomainService.com", + "replicaSets": [ + { + "location": "West US", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "pfxCertificatePassword": "", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + } + } + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "externalAccessIpAddress": "13.64.148.151", + "serviceStatus": "Running" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation completed successfully.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "externalAccessIpAddress": "13.64.148.151", + "serviceStatus": "Running" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "replicaSets": [ + { + "location": "West US", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateOuContainer.json index 7f434016e9cd..86df92943039 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/CreateOuContainer.json @@ -1,94 +1,94 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1", - "containerAccount": { - "accountName": "AccountName1", - "spn": "Spn1", - "password": "" - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1", + "containerAccount": { + "accountName": "AccountName1", + "spn": "Spn1", + "password": "" + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteDomainService.json index 7c8f7f479605..d0027523f5aa 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteDomainService.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "TestResourceGroup", - "domainServiceName": "TestDomainService.com" - }, - "responses": { - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "TestResourceGroup", + "domainServiceName": "TestDomainService.com" + }, + "responses": { + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteOuContainer.json index 0456d858fadf..9f3c63e876a0 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/DeleteOuContainer.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetDomainService.json index 6d18688a51e7..28d38fb8d575 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetDomainService.json @@ -1,85 +1,85 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "TestResourceGroup", - "domainServiceName": "TestDomainService.com" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "externalAccessIpAddress": "13.64.148.151", - "serviceStatus": "Running", - "healthLastEvaluated": "2018-02-15T21:43:21Z", - "healthMonitors": [ - { - "id": "AADDS501", - "name": "Backup", - "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT" - }, - { - "id": "AADDS500", - "name": "Synchronization with Azure AD", - "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT." - } - ], - "healthAlerts": [ - { - "id": "AADDS104", - "name": "The managed domain is experiencing a network error", - "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.", - "severity": "2", - "raised": "2018-09-18T01:55:40.7834289Z", - "lastDetected": "2018-09-18T17:46:39.2697888Z", - "resolutionUri": "https://aka.ms/aadds-neterr" - } - ] - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "TestResourceGroup", + "domainServiceName": "TestDomainService.com" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "externalAccessIpAddress": "13.64.148.151", + "serviceStatus": "Running", + "healthLastEvaluated": "2018-02-15T21:43:21Z", + "healthMonitors": [ + { + "id": "AADDS501", + "name": "Backup", + "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT" + }, + { + "id": "AADDS500", + "name": "Synchronization with Azure AD", + "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT." + } + ], + "healthAlerts": [ + { + "id": "AADDS104", + "name": "The managed domain is experiencing a network error", + "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.", + "severity": "2", + "raised": "2018-09-18T01:55:40.7834289Z", + "lastDetected": "2018-09-18T17:46:39.2697888Z", + "resolutionUri": "https://aka.ms/aadds-neterr" + } + ] + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOperations.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOperations.json index b2e945fc2047..df9537d5c20f 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOperations.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOperations.json @@ -1,63 +1,63 @@ -{ - "parameters": { - "api-version": "2021-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.AAD/unregister/action", - "display": { - "provider": "Domain Services Resource Provider", - "resource": "Domain Service Type", - "operation": "Unregister Domain Service", - "description": "Unregisters Domain Services" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.AAD/register/action", - "display": { - "provider": "Domain Services Resource Provider", - "resource": "Domain Service Type", - "operation": "Register Domain Service", - "description": "Registers Domain Services" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.AAD/domainServices/read", - "display": { - "provider": "Domain Services Resource Provider", - "resource": "Domain Service Type", - "operation": "Read Domain Service", - "description": "Reads Domain Services" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.AAD/domainServices/write", - "display": { - "provider": "Domain Services Resource Provider", - "resource": "Domain Service Type", - "operation": "Write Domain Service", - "description": "Writes Domain Services" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.AAD/domainServices/delete", - "display": { - "provider": "Domain Services Resource Provider", - "resource": "Domain Service Type", - "operation": "Delete Domain Service", - "description": "Deletes Domain Services" - }, - "origin": "user,system" - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AAD/unregister/action", + "display": { + "provider": "Domain Services Resource Provider", + "resource": "Domain Service Type", + "operation": "Unregister Domain Service", + "description": "Unregisters Domain Services" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.AAD/register/action", + "display": { + "provider": "Domain Services Resource Provider", + "resource": "Domain Service Type", + "operation": "Register Domain Service", + "description": "Registers Domain Services" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.AAD/domainServices/read", + "display": { + "provider": "Domain Services Resource Provider", + "resource": "Domain Service Type", + "operation": "Read Domain Service", + "description": "Reads Domain Services" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.AAD/domainServices/write", + "display": { + "provider": "Domain Services Resource Provider", + "resource": "Domain Service Type", + "operation": "Write Domain Service", + "description": "Writes Domain Services" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.AAD/domainServices/delete", + "display": { + "provider": "Domain Services Resource Provider", + "resource": "Domain Service Type", + "operation": "Delete Domain Service", + "description": "Deletes Domain Services" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOuContainer.json index dd3326ec26a8..fe3e4df2c077 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/GetOuContainer.json @@ -1,37 +1,37 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesByResourceGroup.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesByResourceGroup.json index fc205fb008db..a9733d549191 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesByResourceGroup.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesByResourceGroup.json @@ -1,88 +1,88 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "TestResourceGroup" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "value": [ - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "externalAccessIpAddress": "13.64.148.151", - "serviceStatus": "Running", - "healthLastEvaluated": "2018-02-15T21:43:21Z", - "healthMonitors": [ - { - "id": "AADDS501", - "name": "Backup", - "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT" - }, - { - "id": "AADDS500", - "name": "Synchronization with Azure AD", - "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT." - } - ], - "healthAlerts": [ - { - "id": "AADDS104", - "name": "The managed domain is experiencing a network error", - "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.", - "severity": "2", - "raised": "2018-09-18T01:55:40.7834289Z", - "lastDetected": "2018-09-18T17:46:39.2697888Z", - "resolutionUri": "https://aka.ms/aadds-neterr" - } - ] - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "TestResourceGroup" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "value": [ + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "externalAccessIpAddress": "13.64.148.151", + "serviceStatus": "Running", + "healthLastEvaluated": "2018-02-15T21:43:21Z", + "healthMonitors": [ + { + "id": "AADDS501", + "name": "Backup", + "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT" + }, + { + "id": "AADDS500", + "name": "Synchronization with Azure AD", + "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT." + } + ], + "healthAlerts": [ + { + "id": "AADDS104", + "name": "The managed domain is experiencing a network error", + "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.", + "severity": "2", + "raised": "2018-09-18T01:55:40.7834289Z", + "lastDetected": "2018-09-18T17:46:39.2697888Z", + "resolutionUri": "https://aka.ms/aadds-neterr" + } + ] + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesBySubscription.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesBySubscription.json index c63945a218e4..00428ee0e7c9 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesBySubscription.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListDomainServicesBySubscription.json @@ -1,87 +1,87 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "value": [ - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "externalAccessIpAddress": "13.64.148.151", - "serviceStatus": "Running", - "healthLastEvaluated": "2018-02-15T21:43:21Z", - "healthMonitors": [ - { - "id": "AADDS501", - "name": "Backup", - "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT" - }, - { - "id": "AADDS500", - "name": "Synchronization with Azure AD", - "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT." - } - ], - "healthAlerts": [ - { - "id": "AADDS104", - "name": "The managed domain is experiencing a network error", - "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.", - "severity": "2", - "raised": "2018-09-18T01:55:40.7834289Z", - "lastDetected": "2018-09-18T17:46:39.2697888Z", - "resolutionUri": "https://aka.ms/aadds-neterr" - } - ] - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "value": [ + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "externalAccessIpAddress": "13.64.148.151", + "serviceStatus": "Running", + "healthLastEvaluated": "2018-02-15T21:43:21Z", + "healthMonitors": [ + { + "id": "AADDS501", + "name": "Backup", + "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT" + }, + { + "id": "AADDS500", + "name": "Synchronization with Azure AD", + "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT." + } + ], + "healthAlerts": [ + { + "id": "AADDS104", + "name": "The managed domain is experiencing a network error", + "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.", + "severity": "2", + "raised": "2018-09-18T01:55:40.7834289Z", + "lastDetected": "2018-09-18T17:46:39.2697888Z", + "resolutionUri": "https://aka.ms/aadds-neterr" + } + ] + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListOuContainers.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListOuContainers.json index 4086edb22c11..472219f272af 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListOuContainers.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/ListOuContainers.json @@ -1,63 +1,63 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com" - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "value": [ - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2", - "name": "OuContainer.com/OuContainer2", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer2", - "accounts": [ - { - "accountName": "AccountName3", - "spn": "Spn3" - }, - { - "accountName": "AccountName4", - "spn": "Spn4" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com" + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "value": [ + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2", + "name": "OuContainer.com/OuContainer2", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer2", + "accounts": [ + { + "accountName": "AccountName3", + "spn": "Spn3" + }, + { + "accountName": "AccountName4", + "spn": "Spn4" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateDomainService.json index c34d043bcecb..750a44c58683 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateDomainService.json @@ -1,160 +1,160 @@ -{ - "parameters": { - "api-version": "2020-01-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "TestResourceGroup", - "domainServiceName": "TestDomainService.com", - "domainService": { - "properties": { - "replicaSets": [ - { - "location": "West US", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS" - }, - { - "location": "East US", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "pfxCertificatePassword": "", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - } - } - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "externalAccessIpAddress": "13.64.148.151", - "serviceStatus": "Running" - }, - { - "replicaSetId": "5057347d-cad1-4ec8-8db6-66cf7eedf4b8", - "location": "East US", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS", - "domainControllerIpAddress": [ - "10.0.0.3", - "10.0.0.4" - ], - "externalAccessIpAddress": "13.64.148.152", - "serviceStatus": "Running" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", - "name": "TestDomainService.com", - "type": "Microsoft.AAD/DomainServices", - "properties": { - "version": 2, - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "TestDomainService.com", - "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "replicaSets": [ - { - "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", - "location": "West US", - "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", - "domainControllerIpAddress": [ - "10.0.0.1", - "10.0.0.2" - ], - "serviceStatus": "Running" - }, - { - "location": "East US", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS" - } - ], - "ldapsSettings": { - "ldaps": "Enabled", - "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", - "certificateNotAfter": "2018-02-15T21:43:21Z", - "externalAccess": "Enabled" - }, - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "filteredSync": "Enabled", - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ - "jicha@microsoft.com", - "caalmont@microsoft.com" - ] - }, - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "TestResourceGroup", + "domainServiceName": "TestDomainService.com", + "domainService": { + "properties": { + "replicaSets": [ + { + "location": "West US", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS" + }, + { + "location": "East US", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "pfxCertificatePassword": "", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + } + } + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "externalAccessIpAddress": "13.64.148.151", + "serviceStatus": "Running" + }, + { + "replicaSetId": "5057347d-cad1-4ec8-8db6-66cf7eedf4b8", + "location": "East US", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS", + "domainControllerIpAddress": [ + "10.0.0.3", + "10.0.0.4" + ], + "externalAccessIpAddress": "13.64.148.152", + "serviceStatus": "Running" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com", + "name": "TestDomainService.com", + "type": "Microsoft.AAD/DomainServices", + "properties": { + "version": 2, + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "TestDomainService.com", + "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "replicaSets": [ + { + "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a", + "location": "West US", + "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS", + "domainControllerIpAddress": [ + "10.0.0.1", + "10.0.0.2" + ], + "serviceStatus": "Running" + }, + { + "location": "East US", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS" + } + ], + "ldapsSettings": { + "ldaps": "Enabled", + "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3", + "certificateNotAfter": "2018-02-15T21:43:21Z", + "externalAccess": "Enabled" + }, + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "filteredSync": "Enabled", + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ + "jicha@microsoft.com", + "caalmont@microsoft.com" + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateOuContainer.json index f988fe56fa0c..fdfe70feff2f 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateOuContainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/examples/UpdateOuContainer.json @@ -1,68 +1,68 @@ -{ - "parameters": { - "api-version": "2021-03-01", - "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", - "resourceGroupName": "OuContainerResourceGroup", - "domainServiceName": "OuContainer.com", - "ouContainerName": "OuContainer1", - "containerAccount": { - "accountName": "AccountName1", - "spn": "Spn1", - "password": "" - } - }, - "responses": { - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "body": { - "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", - "name": "OuContainer.com/OuContainer1", - "type": "Microsoft.AAD/DomainServices/OuContainer", - "properties": { - "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", - "domainName": "OuContainer.com", - "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", - "containerId": "OuContainer1", - "accounts": [ - { - "accountName": "AccountName1", - "spn": "Spn1" - }, - { - "accountName": "AccountName2", - "spn": "Spn2" - } - ], - "serviceStatus": "Running", - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2021-03-01", + "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", + "resourceGroupName": "OuContainerResourceGroup", + "domainServiceName": "OuContainer.com", + "ouContainerName": "OuContainer1", + "containerAccount": { + "accountName": "AccountName1", + "spn": "Spn1", + "password": "" + } + }, + "responses": { + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "body": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1", + "name": "OuContainer.com/OuContainer1", + "type": "Microsoft.AAD/DomainServices/OuContainer", + "properties": { + "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def", + "domainName": "OuContainer.com", + "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B", + "containerId": "OuContainer1", + "accounts": [ + { + "accountName": "AccountName1", + "spn": "Spn1" + }, + { + "accountName": "AccountName2", + "spn": "Spn2" + } + ], + "serviceStatus": "Running", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/oucontainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/oucontainer.json index ea6954575cfb..a637b9b0be74 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/oucontainer.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/oucontainer.json @@ -1,613 +1,613 @@ -{ - "swagger": "2.0", - "info": { - "title": "Domain Services Resource Provider", - "description": "The AAD Domain Services API.", - "version": "2021-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Aad/operations": { - "get": { - "tags": [ - "OuContainer" - ], - "description": "Lists all the available OuContainer operations.", - "operationId": "OuContainerOperations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - } - } - }, - "x-ms-examples": { - "Get Operations": { - "$ref": "./examples/GetOperations.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": { - "get": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_List", - "summary": "List of OuContainers in DomainService instance", - "description": "The List of OuContainers in DomainService instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainerListResult" - } - } - }, - "x-ms-examples": { - "List of OuContainers": { - "$ref": "./examples/ListOuContainers.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": { - "get": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Get", - "summary": "Get particular OuContainer in DomainService instance", - "description": "Get OuContainer in DomainService instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-examples": { - "List of OuContainers": { - "$ref": "./examples/GetOuContainer.json" - } - } - }, - "put": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Create", - "summary": "Create OuContainer", - "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - }, - { - "name": "containerAccount", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ContainerAccount" - }, - "description": "Container Account Description." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "201": { - "description": "HTTP 201 (Created) if the operation completed successfully.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create Domain Service": { - "$ref": "./examples/CreateOuContainer.json" - } - } - }, - "delete": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Delete", - "summary": "Delete OuContainer", - "description": "The Delete OuContainer operation deletes specified OuContainer.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "204": { - "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete OuContainer": { - "$ref": "./examples/DeleteOuContainer.json" - } - } - }, - "patch": { - "tags": [ - "OuContainer" - ], - "operationId": "OuContainer_Update", - "summary": "Update OuContainer (PATCH Resource)", - "description": "The Update OuContainer operation can be used to update the existing OuContainers.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/DomainServiceNameParameter" - }, - { - "$ref": "#/parameters/OuContainerNameParameter" - }, - { - "name": "containerAccount", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ContainerAccount" - }, - "description": "Container Account Description." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "200": { - "description": "HTTP 200 (OK) if the operation was successful.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "schema": { - "$ref": "#/definitions/OuContainer" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update Domain Service": { - "$ref": "./examples/UpdateOuContainer.json" - } - } - } - } - }, - "definitions": { - "Resource": { - "description": "The Resource model definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "etag": { - "type": "string", - "description": "Resource etag" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "x-ms-azure-resource": true - }, - "OuContainerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OuContainer" - }, - "description": "The list of OuContainer." - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - }, - "description": "The response from the List OuContainer operation." - }, - "OuContainer": { - "description": "Resource for OuContainer.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OuContainerProperties", - "description": "OuContainer properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "OuContainerProperties": { - "description": "Properties of the OuContainer.", - "properties": { - "tenantId": { - "readOnly": true, - "type": "string", - "description": "Azure Active Directory tenant id" - }, - "domainName": { - "readOnly": true, - "type": "string", - "description": "The domain name of Domain Services." - }, - "deploymentId": { - "readOnly": true, - "type": "string", - "description": "The Deployment id" - }, - "containerId": { - "readOnly": true, - "type": "string", - "description": "The OuContainer name" - }, - "accounts": { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerAccount", - "description": "Container Account" - }, - "description": "The list of container accounts" - }, - "serviceStatus": { - "readOnly": true, - "type": "string", - "description": "Status of OuContainer instance" - }, - "distinguishedName": { - "readOnly": true, - "type": "string", - "description": "Distinguished Name of OuContainer instance" - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response." - } - } - }, - "ContainerAccount": { - "description": "Container Account Description", - "properties": { - "accountName": { - "type": "string", - "description": "The account name" - }, - "spn": { - "type": "string", - "description": "The account spn" - }, - "password": { - "type": "string", - "description": "The account password" - } - } - }, - "OperationEntityListResult": { - "description": "The list of domain service operation response.", - "type": "object", - "properties": { - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - }, - "nextLink": { - "type": "string", - "description": "The continuation token for the next page of results.", - "readOnly": true - } - } - }, - "OperationEntity": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by Domain Services." - }, - "origin": { - "description": "The origin of the operation.", - "type": "string" - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by Domain Services.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Domain Services.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "description": "An error response from the Domain Services.", - "$ref": "#/definitions/CloudErrorBody" - } - }, - "description": "An error response from the Domain Services." - }, - "CloudErrorBody": { - "x-ms-external": true, - "properties": { - "code": { - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Domain Services." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "DomainServiceNameParameter": { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service.", - "x-ms-parameter-location": "method" - }, - "OuContainerNameParameter": { - "name": "ouContainerName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the OuContainer.", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Domain Services Resource Provider", + "description": "The AAD Domain Services API.", + "version": "2021-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Aad/operations": { + "get": { + "tags": [ + "OuContainer" + ], + "description": "Lists all the available OuContainer operations.", + "operationId": "OuContainerOperations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": { + "get": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_List", + "summary": "List of OuContainers in DomainService instance", + "description": "The List of OuContainers in DomainService instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainerListResult" + } + } + }, + "x-ms-examples": { + "List of OuContainers": { + "$ref": "./examples/ListOuContainers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": { + "get": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Get", + "summary": "Get particular OuContainer in DomainService instance", + "description": "Get OuContainer in DomainService instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-examples": { + "List of OuContainers": { + "$ref": "./examples/GetOuContainer.json" + } + } + }, + "put": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Create", + "summary": "Create OuContainer", + "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + }, + { + "name": "containerAccount", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerAccount" + }, + "description": "Container Account Description." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "201": { + "description": "HTTP 201 (Created) if the operation completed successfully.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Domain Service": { + "$ref": "./examples/CreateOuContainer.json" + } + } + }, + "delete": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Delete", + "summary": "Delete OuContainer", + "description": "The Delete OuContainer operation deletes specified OuContainer.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "204": { + "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete OuContainer": { + "$ref": "./examples/DeleteOuContainer.json" + } + } + }, + "patch": { + "tags": [ + "OuContainer" + ], + "operationId": "OuContainer_Update", + "summary": "Update OuContainer (PATCH Resource)", + "description": "The Update OuContainer operation can be used to update the existing OuContainers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DomainServiceNameParameter" + }, + { + "$ref": "#/parameters/OuContainerNameParameter" + }, + { + "name": "containerAccount", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerAccount" + }, + "description": "Container Account Description." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "HTTP 200 (OK) if the operation was successful.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/OuContainer" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Domain Service": { + "$ref": "./examples/UpdateOuContainer.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "etag": { + "type": "string", + "description": "Resource etag" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "OuContainerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OuContainer" + }, + "description": "The list of OuContainer." + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + }, + "description": "The response from the List OuContainer operation." + }, + "OuContainer": { + "description": "Resource for OuContainer.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OuContainerProperties", + "description": "OuContainer properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "OuContainerProperties": { + "description": "Properties of the OuContainer.", + "properties": { + "tenantId": { + "readOnly": true, + "type": "string", + "description": "Azure Active Directory tenant id" + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "The domain name of Domain Services." + }, + "deploymentId": { + "readOnly": true, + "type": "string", + "description": "The Deployment id" + }, + "containerId": { + "readOnly": true, + "type": "string", + "description": "The OuContainer name" + }, + "accounts": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAccount", + "description": "Container Account" + }, + "description": "The list of container accounts" + }, + "serviceStatus": { + "readOnly": true, + "type": "string", + "description": "Status of OuContainer instance" + }, + "distinguishedName": { + "readOnly": true, + "type": "string", + "description": "Distinguished Name of OuContainer instance" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ContainerAccount": { + "description": "Container Account Description", + "properties": { + "accountName": { + "type": "string", + "description": "The account name" + }, + "spn": { + "type": "string", + "description": "The account spn" + }, + "password": { + "type": "string", + "description": "The account password" + } + } + }, + "OperationEntityListResult": { + "description": "The list of domain service operation response.", + "type": "object", + "properties": { + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + }, + "nextLink": { + "type": "string", + "description": "The continuation token for the next page of results.", + "readOnly": true + } + } + }, + "OperationEntity": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Domain Services." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Domain Services.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Domain Services.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "An error response from the Domain Services.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Domain Services." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Domain Services." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "DomainServiceNameParameter": { + "name": "domainServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the domain service.", + "x-ms-parameter-location": "method" + }, + "OuContainerNameParameter": { + "name": "ouContainerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the OuContainer.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/domainservices/resource-manager/readme.md b/specification/domainservices/resource-manager/readme.md index 3d9a5fbc0b66..3584487b5d63 100644 --- a/specification/domainservices/resource-manager/readme.md +++ b/specification/domainservices/resource-manager/readme.md @@ -1,257 +1,257 @@ -# DomainServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DomainServices. - - - ---- -## Getting Started -To build the SDK for DomainServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the DomainServices API. - -``` yaml -openapi-type: arm -tag: package-2022-12 -``` - -### Tag: package-2022-12 - -These settings apply only when `--tag=package-2022-12` is specified on the command line. - -``` yaml $(tag) == 'package-2022-12' -input-file: -- Microsoft.AAD/stable/2022-12-01/domainservices.json -- Microsoft.AAD/stable/2022-12-01/oucontainer.json -``` - -### Tag: package-2022-09 - -These settings apply only when `--tag=package-2022-09` is specified on the command line. - -``` yaml $(tag) == 'package-2022-09' -input-file: -- Microsoft.AAD/stable/2022-09-01/domainservices.json -- Microsoft.AAD/stable/2022-09-01/oucontainer.json -``` - -### Tag: package-2021-05 - -These settings apply only when `--tag=package-2021-05` is specified on the command line. - -``` yaml $(tag) == 'package-2021-05' -input-file: -- Microsoft.AAD/stable/2021-05-01/domainservices.json -- Microsoft.AAD/stable/2021-05-01/oucontainer.json -``` - -### Tag: package-2021-03 - -These settings apply only when `--tag=package-2021-03` is specified on the command line. - -``` yaml $(tag) == 'package-2021-03' -input-file: -- Microsoft.AAD/stable/2021-03-01/domainservices.json -- Microsoft.AAD/stable/2021-03-01/oucontainer.json -``` - -### Tag: package-2020-01 - -These settings apply only when `--tag=package-2020-01` is specified on the command line. - -``` yaml $(tag) == 'package-2020-01' -input-file: -- Microsoft.AAD/stable/2020-01-01/domainservices.json -- Microsoft.AAD/stable/2020-01-01/oucontainer.json -``` - -### Tag: package-2017-06 - -These settings apply only when `--tag=package-2017-06` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06' -input-file: -- Microsoft.AAD/stable/2017-06-01/domainservices.json -- Microsoft.AAD/stable/2017-06-01/oucontainer.json -``` - -### Tag: package-2017-01 - -These settings apply only when `--tag=package-2017-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-01' -input-file: -- Microsoft.AAD/stable/2017-01-01/domainservices.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-net - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-powershell -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DomainServices - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/domainservices/Microsoft.Azure.Management.DomainServices/src/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.domainservices -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-domainservices -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2022-12 - - tag: package-2022-09 - - tag: package-2021-05 - - tag: package-2021-03 - - tag: package-2020-01 - - tag: package-2017-06 - - tag: package-2017-01 -``` - -### Tag: package-2022-12 and java - -These settings apply only when `--tag=package-2022-12 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2022-12' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2022_12_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2022_12_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2022-09 and java - -These settings apply only when `--tag=package-2022-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2022-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2022_09_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2022_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2021-05 and java - -These settings apply only when `--tag=package-2021-05 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2021-05' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2021_05_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2021_05_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2021-03 and java - -These settings apply only when `--tag=package-2021-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2021-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2021_03_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2021_03_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2020-01 and java - -These settings apply only when `--tag=package-2020-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2020-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2020_01_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2020_01_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-06 and java - -These settings apply only when `--tag=package-2017-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2017_06_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2017_06_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-01 and java - -These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.domainservices.v2017_01_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2017_01_01 -regenerate-manager: true -generate-interface: true -``` - - - +# DomainServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DomainServices. + + + +--- +## Getting Started +To build the SDK for DomainServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DomainServices API. + +``` yaml +openapi-type: arm +tag: package-2022-12 +``` + +### Tag: package-2022-12 + +These settings apply only when `--tag=package-2022-12` is specified on the command line. + +``` yaml $(tag) == 'package-2022-12' +input-file: +- Microsoft.AAD/stable/2022-12-01/domainservices.json +- Microsoft.AAD/stable/2022-12-01/oucontainer.json +``` + +### Tag: package-2022-09 + +These settings apply only when `--tag=package-2022-09` is specified on the command line. + +``` yaml $(tag) == 'package-2022-09' +input-file: +- Microsoft.AAD/stable/2022-09-01/domainservices.json +- Microsoft.AAD/stable/2022-09-01/oucontainer.json +``` + +### Tag: package-2021-05 + +These settings apply only when `--tag=package-2021-05` is specified on the command line. + +``` yaml $(tag) == 'package-2021-05' +input-file: +- Microsoft.AAD/stable/2021-05-01/domainservices.json +- Microsoft.AAD/stable/2021-05-01/oucontainer.json +``` + +### Tag: package-2021-03 + +These settings apply only when `--tag=package-2021-03` is specified on the command line. + +``` yaml $(tag) == 'package-2021-03' +input-file: +- Microsoft.AAD/stable/2021-03-01/domainservices.json +- Microsoft.AAD/stable/2021-03-01/oucontainer.json +``` + +### Tag: package-2020-01 + +These settings apply only when `--tag=package-2020-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-01' +input-file: +- Microsoft.AAD/stable/2020-01-01/domainservices.json +- Microsoft.AAD/stable/2020-01-01/oucontainer.json +``` + +### Tag: package-2017-06 + +These settings apply only when `--tag=package-2017-06` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06' +input-file: +- Microsoft.AAD/stable/2017-06-01/domainservices.json +- Microsoft.AAD/stable/2017-06-01/oucontainer.json +``` + +### Tag: package-2017-01 + +These settings apply only when `--tag=package-2017-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01' +input-file: +- Microsoft.AAD/stable/2017-01-01/domainservices.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-powershell +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DomainServices + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/domainservices/Microsoft.Azure.Management.DomainServices/src/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.domainservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-domainservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2022-12 + - tag: package-2022-09 + - tag: package-2021-05 + - tag: package-2021-03 + - tag: package-2020-01 + - tag: package-2017-06 + - tag: package-2017-01 +``` + +### Tag: package-2022-12 and java + +These settings apply only when `--tag=package-2022-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2022-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2022_12_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2022_12_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2022-09 and java + +These settings apply only when `--tag=package-2022-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2022-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2022_09_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2022_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2021-05 and java + +These settings apply only when `--tag=package-2021-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2021_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2021_05_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2021-03 and java + +These settings apply only when `--tag=package-2021-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2021_03_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2021_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2020-01 and java + +These settings apply only when `--tag=package-2020-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2020_01_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2020_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-06 and java + +These settings apply only when `--tag=package-2017-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2017_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2017_06_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + + + diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json deleted file mode 100644 index c87bf8f2eaea..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json +++ /dev/null @@ -1,3316 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "HybridComputeManagementClient", - "description": "The Hybrid Compute Management Client.", - "version": "2023-04-25-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}": { - "put": { - "tags": [ - "machines" - ], - "operationId": "Machines_CreateOrUpdate", - "description": "The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Machine" - }, - "description": "Parameters supplied to the Create hybrid machine operation." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Machine" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or Update a Machine": { - "$ref": "./examples/Machines_CreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "machines" - ], - "operationId": "Machines_Update", - "description": "The operation to update a hybrid machine.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineUpdate" - }, - "description": "Parameters supplied to the Update hybrid machine operation." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Machine" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update a Machine": { - "$ref": "./examples/Machines_Update.json" - } - } - }, - "delete": { - "tags": [ - "machines" - ], - "operationId": "Machines_Delete", - "description": "The operation to delete a hybrid machine.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete a Machine": { - "$ref": "./examples/Machines_Delete.json" - } - } - }, - "get": { - "tags": [ - "machines" - ], - "operationId": "Machines_Get", - "description": "Retrieves information about the model view or the instance view of a hybrid machine.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation.", - "enum": [ - "instanceView" - ], - "x-ms-enum": { - "name": "InstanceViewTypes", - "modelAsString": true - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Machine" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Machine": { - "$ref": "./examples/Machines_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches": { - "post": { - "tags": [ - "machines" - ], - "operationId": "Machines_AssessPatches", - "x-ms-examples": { - "Assess patch state of a machine.": { - "$ref": "./examples/MachineAssessPatches.json" - } - }, - "description": "The operation to assess patches on a hybrid machine identity in Azure.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the hybrid machine." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineAssessPatchesResult" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches": { - "post": { - "tags": [ - "machines" - ], - "operationId": "Machines_InstallPatches", - "description": "The operation to install patches on a hybrid machine identity in Azure.", - "x-ms-examples": { - "Install patch state of a machine.": { - "$ref": "./examples/MachineInstallPatches.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the hybrid machine." - }, - { - "name": "installPatchesInput", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineInstallPatchesParameters" - }, - "description": "Input for InstallPatches as directly received by the API" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineInstallPatchesResult" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines": { - "get": { - "tags": [ - "machines" - ], - "operationId": "Machines_ListByResourceGroup", - "description": "Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Machines by resource group": { - "$ref": "./examples/Machines_ListByResourceGroup.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines": { - "get": { - "tags": [ - "machines" - ], - "operationId": "Machines_ListBySubscription", - "description": "Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Machines by resource group": { - "$ref": "./examples/Machines_ListBySubscription.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { - "put": { - "tags": [ - "MachineExtensions" - ], - "operationId": "MachineExtensions_CreateOrUpdate", - "description": "The operation to create or update the extension.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the machine where the extension should be created or updated." - }, - { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the machine extension." - }, - { - "name": "extensionParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineExtension" - }, - "description": "Parameters supplied to the Create Machine Extension operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineExtension" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or Update a Machine Extension": { - "$ref": "./examples/PUTExtension.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "MachineExtensions" - ], - "operationId": "MachineExtensions_Update", - "description": "The operation to create or update the extension.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the machine where the extension should be created or updated." - }, - { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the machine extension." - }, - { - "name": "extensionParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineExtensionUpdate" - }, - "description": "Parameters supplied to the Create Machine Extension operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineExtension" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or Update a Machine Extension": { - "$ref": "./examples/UpdateExtension.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "MachineExtensions" - ], - "operationId": "MachineExtensions_Delete", - "description": "The operation to delete the extension.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the machine where the extension should be deleted." - }, - { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the machine extension." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete a Machine Extension": { - "$ref": "./examples/DELETEExtension.json" - } - } - }, - "get": { - "tags": [ - "MachineExtensions" - ], - "operationId": "MachineExtensions_Get", - "description": "The operation to get the extension.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the machine containing the extension." - }, - { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the machine extension." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineExtension" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GET Machine Extension": { - "$ref": "./examples/GETExtension.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions": { - "get": { - "tags": [ - "MachineExtensions" - ], - "operationId": "MachineExtensions_List", - "description": "The operation to get all extensions of a non-Azure machine", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the machine containing the extension." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineExtensionsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GET all Machine Extensions": { - "$ref": "./examples/LISTExtension.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { - "post": { - "tags": [ - "MachineExtensions Upgrade" - ], - "operationId": "UpgradeExtensions", - "description": "The operation to Upgrade Machine Extensions.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - }, - { - "name": "extensionUpgradeParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineExtensionUpgrade" - }, - "description": "Parameters supplied to the Upgrade Extensions operation." - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Upgrade Machine Extensions": { - "$ref": "./examples/Extensions_Upgrade.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}": { - "get": { - "tags": [ - "extensions" - ], - "operationId": "ExtensionMetadata_Get", - "description": "Gets an Extension Metadata based on location, publisher, extensionType and version", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the Extension being received." - }, - { - "name": "publisher", - "in": "path", - "required": true, - "type": "string", - "description": "The publisher of the Extension being received." - }, - { - "name": "extensionType", - "in": "path", - "required": true, - "type": "string", - "description": "The extensionType of the Extension being received." - }, - { - "name": "version", - "in": "path", - "required": true, - "type": "string", - "description": "The version of the Extension being received." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExtensionValue" - } - }, - "default": { - "description": "Error in retrieving an extension metadata", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GET an extensions metadata": { - "$ref": "./examples/ExtensionMetadata_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions": { - "get": { - "tags": [ - "extensions" - ], - "operationId": "ExtensionMetadata_List", - "description": "Gets all Extension versions based on location, publisher, extensionType", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the Extension being received." - }, - { - "name": "publisher", - "in": "path", - "required": true, - "type": "string", - "description": "The publisher of the Extension being received." - }, - { - "name": "extensionType", - "in": "path", - "required": true, - "type": "string", - "description": "The extensionType of the Extension being received." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExtensionValueListResult" - } - }, - "default": { - "description": "Error in retrieving extension list", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "GET a list of extensions": { - "$ref": "./examples/ExtensionMetadata_List.json" - } - } - } - }, - "/providers/Microsoft.HybridCompute/operations": { - "get": { - "tags": [ - "operations" - ], - "operationId": "Operations_List", - "description": "Gets a list of hybrid compute operations.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Hybrid Compute Provider Operations": { - "$ref": "./examples/Operations_List.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/networkProfile": { - "get": { - "tags": [ - "MachineNetworkProfile" - ], - "operationId": "NetworkProfile_Get", - "description": "The operation to get network information of hybrid machine", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkProfile" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GET Network Profile": { - "$ref": "./examples/GETNetworkProfile.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/hybridIdentityMetadata/{metadataName}": { - "get": { - "tags": [ - "HybridIdentityMetadata" - ], - "operationId": "HybridIdentityMetadata_Get", - "summary": "Gets HybridIdentityMetadata.", - "description": "Implements HybridIdentityMetadata GET method.", - "x-ms-examples": { - "GetHybridIdentityMetadata": { - "$ref": "./examples/GetHybridIdentityMetadata.json" - } - }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - }, - { - "in": "path", - "name": "metadataName", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "description": "Name of the HybridIdentityMetadata." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/HybridIdentityMetadata" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/hybridIdentityMetadata": { - "get": { - "tags": [ - "HybridIdentityMetadata" - ], - "operationId": "HybridIdentityMetadata_ListByMachines", - "summary": "Implements GET HybridIdentityMetadata in a machine.", - "description": "Returns the list of HybridIdentityMetadata of the given machine.", - "x-ms-examples": { - "HybridIdentityMetadataListByVirtualMachines": { - "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachines.json" - } - }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "minLength": 1, - "maxLength": 54, - "description": "The name of the hybrid machine." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/HybridIdentityMetadataList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.HybridCompute/osType/{osType}/agentVersions": { - "get": { - "tags": [ - "AgentVersions" - ], - "operationId": "AgentVersion_List", - "description": "Gets all Agent Versions along with the download link currently present.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "osType", - "in": "path", - "required": true, - "type": "string", - "description": "Defines the os type." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AgentVersionsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GET Agent Versions": { - "$ref": "./examples/GETAgentVersions.json" - } - } - } - }, - "/providers/Microsoft.HybridCompute/osType/{osType}/agentVersions/{version}": { - "get": { - "tags": [ - "AgentVersions" - ], - "operationId": "AgentVersion_Get", - "description": "Gets an Agent Version along with the download link currently present.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "osType", - "in": "path", - "required": true, - "type": "string", - "description": "Defines the os type" - }, - { - "name": "version", - "in": "path", - "required": true, - "type": "string", - "description": "Defines the agent version. To get latest, use latest or else a specific agent version." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AgentVersion" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GET Agent Versions": { - "$ref": "./examples/GETLatestAgentVersion.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}": { - "put": { - "tags": [ - "MachineRunCommands" - ], - "operationId": "MachineRunCommands_CreateOrUpdate", - "description": "The operation to create or update a run command.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/machineNameParameter" - }, - { - "name": "runCommandName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "description": "The name of the run command." - }, - { - "name": "runCommandProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineRunCommand" - }, - "description": "Parameters supplied to the Create Run Command." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Updated Resource", - "schema": { - "$ref": "#/definitions/MachineRunCommand" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/MachineRunCommand" - }, - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or Update a Run Command": { - "$ref": "./examples/PutRunCommand.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "tags": [ - "MachineRunCommands" - ], - "operationId": "MachineRunCommands_Update", - "description": "The operation to update the run command.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/machineNameParameter" - }, - { - "name": "runCommandName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "description": "The name of the run command." - }, - { - "name": "runCommandProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MachineRunCommandUpdate" - }, - "description": "Parameters supplied to the Create Run Command." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineRunCommand" - } - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update a Run Command": { - "$ref": "./examples/UpdateRunCommand.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "MachineRunCommands" - ], - "operationId": "MachineRunCommands_Delete", - "description": "The operation to delete a run command.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/machineNameParameter" - }, - { - "name": "runCommandName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "description": "The name of the run command." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Delete a Machine Run Command": { - "$ref": "./examples/DeleteRunCommand.json" - } - } - }, - "get": { - "tags": [ - "MachineRunCommands" - ], - "operationId": "MachineRunCommands_Get", - "description": "The operation to get a run command.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/machineNameParameter" - }, - { - "name": "runCommandName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "description": "The name of the run command." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineRunCommand" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get a Run Command": { - "$ref": "./examples/GetRunCommand.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands": { - "get": { - "tags": [ - "MachineRunCommands" - ], - "operationId": "MachineRunCommands_List", - "description": "The operation to get all the run commands of a non-Azure machine.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/machineNameParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation." - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MachineRunCommandsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GET all Machine Run Commands": { - "$ref": "./examples/ListRunCommand.json" - } - } - } - } - }, - "definitions": { - "ExtensionValueListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ExtensionValue" - }, - "description": "The list of extension metadata", - "x-ms-identifiers": [] - } - }, - "description": "The List Extension Metadata response." - }, - "ExtensionValue": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExtensionValueProperties", - "description": "The single extension based on search criteria" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "description": "Describes a Extension Metadata" - }, - "ExtensionValueProperties": { - "type": "object", - "properties": { - "version": { - "type": "string", - "readOnly": true, - "description": "The version of the Extension being received." - }, - "extensionType": { - "type": "string", - "readOnly": true, - "description": "The type of the Extension being received." - }, - "publisher": { - "type": "string", - "readOnly": true, - "description": "The publisher of the Extension being received." - } - }, - "description": "Describes Extension Metadata properties" - }, - "OperationListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/OperationValue" - }, - "description": "The list of compute operations", - "x-ms-identifiers": [] - } - }, - "description": "The List Compute Operation operation response." - }, - "OperationValue": { - "type": "object", - "properties": { - "origin": { - "type": "string", - "readOnly": true, - "description": "The origin of the compute operation." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the compute operation." - }, - "display": { - "$ref": "#/definitions/OperationValueDisplay", - "description": "Display properties" - }, - "isDataAction": { - "type": "boolean", - "readOnly": true, - "description": "This property indicates if the operation is an action or a data action" - } - }, - "description": "Describes the properties of a Compute Operation value." - }, - "OperationValueDisplay": { - "type": "object", - "properties": { - "operation": { - "type": "string", - "readOnly": true, - "description": "The display name of the compute operation." - }, - "resource": { - "type": "string", - "readOnly": true, - "description": "The display name of the resource the operation applies to." - }, - "description": { - "type": "string", - "readOnly": true, - "description": "The description of the operation." - }, - "provider": { - "type": "string", - "readOnly": true, - "description": "The resource provider for the operation." - } - }, - "description": "Describes the properties of a Hybrid Compute Operation Value Display." - }, - "PatchSettings": { - "type": "object", - "properties": { - "assessmentMode": { - "type": "string", - "description": "Specifies the assessment mode.", - "enum": [ - "ImageDefault", - "AutomaticByPlatform" - ], - "x-ms-enum": { - "name": "AssessmentModeTypes", - "modelAsString": true - } - }, - "patchMode": { - "type": "string", - "description": "Specifies the patch mode.", - "enum": [ - "ImageDefault", - "AutomaticByPlatform", - "AutomaticByOS", - "Manual" - ], - "x-ms-enum": { - "name": "PatchModeTypes", - "modelAsString": true - } - } - }, - "description": "Specifies the patch settings." - }, - "AgentConfiguration": { - "type": "object", - "readOnly": true, - "properties": { - "proxyUrl": { - "type": "string", - "readOnly": true, - "description": "Specifies the URL of the proxy to be used." - }, - "incomingConnectionsPorts": { - "type": "array", - "readOnly": true, - "description": "Specifies the list of ports that the agent will be able to listen on.", - "items": { - "type": "string" - } - }, - "extensionsAllowList": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ConfigurationExtension" - }, - "description": "Array of extensions that are allowed to be installed or updated.", - "x-ms-identifiers": [] - }, - "extensionsBlockList": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ConfigurationExtension" - }, - "description": "Array of extensions that are blocked (cannot be installed or updated)", - "x-ms-identifiers": [] - }, - "proxyBypass": { - "type": "array", - "readOnly": true, - "description": "List of service names which should not use the specified proxy server.", - "items": { - "type": "string" - } - }, - "extensionsEnabled": { - "type": "string", - "readOnly": true, - "description": "Specifies whether the extension service is enabled or disabled." - }, - "guestConfigurationEnabled": { - "type": "string", - "readOnly": true, - "description": "Specified whether the guest configuration service is enabled or disabled." - }, - "configMode": { - "type": "string", - "readOnly": true, - "description": "Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.", - "enum": [ - "full", - "monitor" - ], - "x-ms-enum": { - "name": "agent configuration mode", - "modelAsString": true - } - } - }, - "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM." - }, - "ConfigurationExtension": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "readOnly": true, - "description": "Publisher of the extension." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Type of the extension." - } - }, - "description": "Describes properties that can identify extensions." - }, - "ServiceStatuses": { - "type": "object", - "properties": { - "extensionService": { - "$ref": "#/definitions/ServiceStatus", - "description": "The state of the extension service on the Arc-enabled machine." - }, - "guestConfigurationService": { - "$ref": "#/definitions/ServiceStatus", - "description": "The state of the guest configuration service on the Arc-enabled machine." - } - }, - "description": "Reports the state and behavior of dependent services." - }, - "ServiceStatus": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The current status of the service." - }, - "startupType": { - "type": "string", - "description": "The behavior of the service when the Arc-enabled machine starts up." - } - }, - "description": "Describes the status and behavior of a service." - }, - "CloudMetadata": { - "type": "object", - "properties": { - "provider": { - "type": "string", - "readOnly": true, - "description": "Specifies the cloud provider (Azure/AWS/GCP...)." - } - }, - "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." - }, - "AgentUpgrade": { - "type": "object", - "properties": { - "desiredVersion": { - "type": "string", - "description": "Specifies the version info w.r.t AgentUpgrade for the machine." - }, - "correlationId": { - "type": "string", - "description": "The correlation ID passed in from RSM per upgrade." - }, - "enableAutomaticUpgrade": { - "type": "boolean", - "description": "Specifies if RSM should try to upgrade this machine" - }, - "lastAttemptDesiredVersion": { - "type": "string", - "readOnly": true, - "description": "Specifies the version of the last attempt" - }, - "lastAttemptTimestamp": { - "type": "string", - "readOnly": true, - "description": "Timestamp of last upgrade attempt" - }, - "lastAttemptStatus": { - "type": "string", - "readOnly": true, - "enum": [ - "Success", - "Failed" - ], - "x-ms-enum": { - "name": "LastAttemptStatusEnum", - "modelAsString": true - }, - "description": "Specifies the status of Agent Upgrade." - }, - "lastAttemptMessage": { - "type": "string", - "readOnly": true, - "description": "Failure message of last upgrade attempt if any." - } - }, - "description": "The info w.r.t Agent Upgrade." - }, - "OSProfile": { - "type": "object", - "properties": { - "computerName": { - "type": "string", - "readOnly": true, - "description": "Specifies the host OS name of the hybrid machine." - }, - "windowsConfiguration": { - "type": "object", - "properties": { - "patchSettings": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PatchSettings" - } - }, - "description": "Specifies the windows configuration for update management." - }, - "linuxConfiguration": { - "type": "object", - "properties": { - "patchSettings": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PatchSettings" - } - }, - "description": "Specifies the linux configuration for update management." - } - }, - "description": "Specifies the operating system settings for the hybrid machine." - }, - "DetectedProperties": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Detected properties from the machine." - }, - "MachineProperties": { - "type": "object", - "properties": { - "locationData": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/locationData" - }, - "agentConfiguration": { - "$ref": "#/definitions/AgentConfiguration", - "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM." - }, - "serviceStatuses": { - "$ref": "#/definitions/ServiceStatuses", - "description": "Statuses of dependent services that are reported back to ARM." - }, - "cloudMetadata": { - "$ref": "#/definitions/CloudMetadata", - "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." - }, - "agentUpgrade": { - "$ref": "#/definitions/AgentUpgrade", - "description": "The info of the machine w.r.t Agent Upgrade" - }, - "osProfile": { - "$ref": "#/definitions/OSProfile", - "description": "Specifies the operating system settings for the hybrid machine." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "The status of the hybrid machine agent.", - "enum": [ - "Connected", - "Disconnected", - "Error" - ], - "x-ms-enum": { - "name": "StatusTypes", - "modelAsString": true - } - }, - "lastStatusChange": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time of the last status change." - }, - "errorDetails": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail" - }, - "description": "Details about the error state.", - "x-ms-identifiers": [] - }, - "agentVersion": { - "readOnly": true, - "type": "string", - "description": "The hybrid machine agent full version." - }, - "vmId": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Specifies the hybrid machine unique ID." - }, - "displayName": { - "readOnly": true, - "type": "string", - "description": "Specifies the hybrid machine display name." - }, - "machineFqdn": { - "readOnly": true, - "type": "string", - "description": "Specifies the hybrid machine FQDN." - }, - "clientPublicKey": { - "type": "string", - "description": "Public Key that the client provides to be used during initial resource onboarding" - }, - "osName": { - "readOnly": true, - "type": "string", - "description": "The Operating System running on the hybrid machine." - }, - "osVersion": { - "readOnly": true, - "type": "string", - "description": "The version of Operating System running on the hybrid machine." - }, - "osType": { - "type": "string", - "description": "The type of Operating System (windows/linux)." - }, - "vmUuid": { - "readOnly": true, - "type": "string", - "description": "Specifies the Arc Machine's unique SMBIOS ID" - }, - "extensions": { - "type": "array", - "items": { - "$ref": "#/definitions/MachineExtensionInstanceView" - }, - "description": "Machine Extensions information (deprecated field)", - "x-ms-identifiers": [] - }, - "osSku": { - "readOnly": true, - "type": "string", - "description": "Specifies the Operating System product SKU." - }, - "domainName": { - "readOnly": true, - "type": "string", - "description": "Specifies the Windows domain name." - }, - "adFqdn": { - "readOnly": true, - "type": "string", - "description": "Specifies the AD fully qualified display name." - }, - "dnsFqdn": { - "readOnly": true, - "type": "string", - "description": "Specifies the DNS fully qualified display name." - }, - "privateLinkScopeResourceId": { - "type": "string", - "description": "The resource id of the private link scope this machine is assigned to, if any." - }, - "parentClusterResourceId": { - "type": "string", - "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." - }, - "mssqlDiscovered": { - "type": "string", - "description": "Specifies whether any MS SQL instance is discovered on the machine." - }, - "detectedProperties": { - "$ref": "#/definitions/DetectedProperties", - "description": "Detected properties from the machine." - }, - "networkProfile": { - "$ref": "#/definitions/NetworkProfile", - "description": "Information about the network the machine is on." - } - }, - "description": "Describes the properties of a hybrid machine." - }, - "MachineUpdateProperties": { - "type": "object", - "properties": { - "locationData": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/locationData" - }, - "osProfile": { - "$ref": "#/definitions/OSProfile" - }, - "cloudMetadata": { - "$ref": "#/definitions/CloudMetadata", - "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." - }, - "agentUpgrade": { - "$ref": "#/definitions/AgentUpgrade", - "description": "The info of the machine w.r.t Agent Upgrade" - }, - "parentClusterResourceId": { - "type": "string", - "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." - }, - "privateLinkScopeResourceId": { - "type": "string", - "description": "The resource id of the private link scope this machine is assigned to, if any." - } - }, - "description": "Describes the ARM updatable properties of a hybrid machine." - }, - "Machine": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MachineProperties", - "description": "Hybrid Compute Machine properties" - }, - "resources": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/MachineExtension" - }, - "description": "The list of extensions affiliated to the machine" - }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity" - }, - "kind": { - "type": "string", - "description": "Indicates which kind of VM fabric the instance is an instance of, such as HCI or SCVMM etc.", - "enum": [ - "AVS", - "HCI", - "SCVMM", - "VMware" - ], - "x-ms-enum": { - "name": "privateCloudKind", - "modelAsString": true - } - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "description": "Describes a hybrid machine." - }, - "MachineUpdate": { - "type": "object", - "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity" - }, - "kind": { - "type": "string", - "description": "Indicates which kind of VM fabric the instance is an instance of, such as HCI or SCVMM etc.", - "enum": [ - "AVS", - "HCI", - "SCVMM", - "VMware" - ], - "x-ms-enum": { - "name": "privateCloudKind", - "modelAsString": true - } - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MachineUpdateProperties", - "description": "Hybrid Compute Machine properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceUpdate" - } - ], - "description": "Describes a hybrid machine Update." - }, - "MachineListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Machine" - }, - "description": "The list of hybrid machines." - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines." - } - }, - "required": [ - "value" - ], - "description": "The List hybrid machine operation response." - }, - "ResourceUpdate": { - "type": "object", - "description": "The Update Resource model definition.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - } - }, - "MachineExtension": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MachineExtensionProperties", - "description": "Describes Machine Extension Properties." - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "description": "Describes a Machine Extension." - }, - "MachineExtensionUpdate": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MachineExtensionUpdateProperties", - "description": "Describes Machine Extension Update Properties." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceUpdate" - } - ], - "description": "Describes a Machine Extension Update." - }, - "MachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "enableAutomaticUpgrade": { - "type": "boolean", - "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." - }, - "autoUpgradeMinorVersion": { - "type": "boolean", - "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." - }, - "settings": { - "type": "object", - "additionalProperties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "additionalProperties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "instanceView": { - "$ref": "#/definitions/MachineExtensionInstanceView", - "description": "The machine extension instance view." - } - }, - "description": "Describes the properties of a Machine Extension." - }, - "MachineExtensionUpdateProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "enableAutomaticUpgrade": { - "type": "boolean", - "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." - }, - "autoUpgradeMinorVersion": { - "type": "boolean", - "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." - }, - "settings": { - "type": "object", - "additionalProperties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "additionalProperties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - } - }, - "description": "Describes the properties of a Machine Extension." - }, - "MachineExtensionInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "status": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "type": "string", - "description": "The level code.", - "enum": [ - "Info", - "Warning", - "Error" - ], - "x-ms-enum": { - "name": "StatusLevelTypes", - "modelAsString": true - } - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - } - }, - "description": "Describes the Machine Extension Instance View." - }, - "MachineExtensionsListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MachineExtension" - }, - "description": "The list of extensions" - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions." - } - }, - "description": "Describes the Machine Extensions List Result." - }, - "TargetVersion": { - "type": "string", - "description": "Extension Upgrade Target Version." - }, - "ExtensionTargetProperties": { - "type": "object", - "properties": { - "targetVersion": { - "type": "object", - "$ref": "#/definitions/TargetVersion", - "description": "Properties for the specified Extension to Upgrade." - } - }, - "description": "Describes the Machine Extension Target Version Properties" - }, - "ExtensionTarget": { - "type": "object", - "additionalProperties": { - "type": "object", - "$ref": "#/definitions/ExtensionTargetProperties" - }, - "description": "Describes the Machine Extension Target Properties" - }, - "MachineExtensionUpgrade": { - "type": "object", - "properties": { - "extensionTargets": { - "$ref": "#/definitions/ExtensionTarget", - "description": "Describes the Extension Target Properties." - } - }, - "description": "Describes the Machine Extension Upgrade Properties." - }, - "NetworkProfile": { - "type": "object", - "readOnly": true, - "properties": { - "networkInterfaces": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "description": "The list of network interfaces.", - "x-ms-identifiers": [] - } - }, - "description": "Describes the network information on this machine." - }, - "NetworkInterface": { - "type": "object", - "readOnly": true, - "properties": { - "ipAddresses": { - "type": "array", - "items": { - "$ref": "#/definitions/IpAddress" - }, - "description": "The list of IP addresses in this interface.", - "x-ms-identifiers": [] - } - }, - "description": "Describes a network interface." - }, - "IpAddress": { - "type": "object", - "readOnly": true, - "properties": { - "address": { - "type": "string", - "description": "Represents the IP Address." - }, - "ipAddressVersion": { - "type": "string", - "description": "Represents the Ip Address Version." - }, - "subnet": { - "type": "object", - "$ref": "#/definitions/Subnet", - "description": "The subnet to which this IP address belongs." - } - }, - "description": "Describes properties of the IP address." - }, - "Subnet": { - "type": "object", - "readOnly": true, - "properties": { - "addressPrefix": { - "type": "string", - "description": "Represents address prefix." - } - }, - "description": "Describes the subnet." - }, - "HybridIdentityMetadataList": { - "description": "List of HybridIdentityMetadata.", - "type": "object", - "properties": { - "nextLink": { - "description": "Url to follow for getting next page of HybridIdentityMetadata.", - "type": "string" - }, - "value": { - "description": "Array of HybridIdentityMetadata", - "type": "array", - "items": { - "$ref": "#/definitions/HybridIdentityMetadata" - } - } - }, - "required": [ - "value" - ] - }, - "HybridIdentityMetadata": { - "description": "Defines the HybridIdentityMetadata.", - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", - "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags." - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Resource properties.", - "$ref": "#/definitions/HybridIdentityMetadataProperties" - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", - "description": "The system data." - } - }, - "x-ms-azure-resource": true - }, - "HybridIdentityMetadataProperties": { - "description": "Defines the resource properties.", - "type": "object", - "properties": { - "vmId": { - "description": "The unique identifier for the resource.", - "type": "string" - }, - "publicKey": { - "description": "The Public Key.", - "type": "string" - }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity", - "readOnly": true - } - } - }, - "AgentVersionsList": { - "type": "object", - "readOnly": true, - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AgentVersion" - }, - "description": "The list of available Agent Versions.", - "x-ms-identifiers": [ - "agentVersion" - ] - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next 10 available Agent Versions." - } - }, - "description": "Describes AgentVersions List." - }, - "AgentVersion": { - "type": "object", - "readOnly": true, - "properties": { - "agentVersion": { - "type": "string", - "description": "Represents the agent version." - }, - "downloadLink": { - "type": "string", - "description": "Represents the download link of specific agent version." - }, - "osType": { - "type": "string", - "description": "Defines the os type." - } - }, - "description": "Describes properties of Agent Version." - }, - "MachineAssessPatchesResult": { - "type": "object", - "properties": { - "status": { - "type": "string", - "readOnly": true, - "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", - "enum": [ - "Unknown", - "InProgress", - "Failed", - "Succeeded", - "CompletedWithWarnings" - ], - "x-ms-enum": { - "name": "PatchOperationStatus", - "modelAsString": true - } - }, - "assessmentActivityId": { - "type": "string", - "readOnly": true, - "description": "The activity ID of the operation that produced this result." - }, - "rebootPending": { - "type": "boolean", - "readOnly": true, - "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." - }, - "availablePatchCountByClassification": { - "$ref": "#/definitions/AvailablePatchCountByClassification", - "description": "Summarization of patches available for installation on the machine by classification." - }, - "startDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The UTC timestamp when the operation began." - }, - "lastModifiedDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The UTC timestamp when the operation finished." - }, - "startedBy": { - "type": "string", - "readOnly": true, - "enum": [ - "User", - "Platform" - ], - "x-ms-enum": { - "name": "PatchOperationStartedBy", - "modelAsString": true - }, - "description": "Indicates if operation was triggered by user or by platform." - }, - "patchServiceUsed": { - "type": "string", - "readOnly": true, - "enum": [ - "Unknown", - "WU", - "WU_WSUS", - "YUM", - "APT", - "Zypper" - ], - "x-ms-enum": { - "name": "PatchServiceUsed", - "modelAsString": true - }, - "description": "Specifies the patch service used for the operation." - }, - "osType": { - "type": "string", - "readOnly": true, - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OsType", - "modelAsString": true - }, - "description": "The operating system type of the machine." - }, - "errorDetails": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", - "readOnly": true, - "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." - } - }, - "description": "Describes the properties of an AssessPatches result." - }, - "AvailablePatchCountByClassification": { - "type": "object", - "properties": { - "security": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of security patches available for installation." - }, - "critical": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of critical patches available for installation." - }, - "definition": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of definition patches available for installation." - }, - "updateRollup": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of update Rollup patches available for installation." - }, - "featurePack": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of feature pack patches available for installation." - }, - "servicePack": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of service pack patches available for installation." - }, - "tools": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of tools patches available for installation." - }, - "updates": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of updates category patches available for installation." - }, - "other": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Number of other patches available for installation." - } - }, - "description": "Summarization of patches available for installation on the machine by classification." - }, - "MachineInstallPatchesParameters": { - "type": "object", - "properties": { - "maximumDuration": { - "type": "string", - "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)" - }, - "rebootSetting": { - "type": "string", - "description": "Defines when it is acceptable to reboot a VM during a software update operation.", - "enum": [ - "IfRequired", - "Never", - "Always" - ], - "x-ms-enum": { - "name": "VMGuestPatchRebootSetting", - "modelAsString": true - } - }, - "windowsParameters": { - "$ref": "#/definitions/WindowsParameters", - "description": "Input for InstallPatches on a Windows VM, as directly received by the API" - }, - "linuxParameters": { - "$ref": "#/definitions/LinuxParameters", - "description": "Input for InstallPatches on a Linux VM, as directly received by the API" - } - }, - "required": [ - "maximumDuration", - "rebootSetting" - ], - "description": "Input for InstallPatches as directly received by the API" - }, - "WindowsParameters": { - "type": "object", - "properties": { - "classificationsToInclude": { - "type": "array", - "description": "The update classifications to select when installing patches for Windows.", - "items": { - "type": "string", - "enum": [ - "Critical", - "Security", - "UpdateRollUp", - "FeaturePack", - "ServicePack", - "Definition", - "Tools", - "Updates" - ], - "x-ms-enum": { - "name": "VMGuestPatchClassification_Windows", - "modelAsString": true - } - } - }, - "kbNumbersToInclude": { - "type": "array", - "description": "Kbs to include in the patch operation", - "items": { - "type": "string" - } - }, - "kbNumbersToExclude": { - "type": "array", - "description": "Kbs to exclude in the patch operation", - "items": { - "type": "string" - } - }, - "excludeKbsRequiringReboot": { - "type": "boolean", - "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true." - }, - "maxPatchPublishDate": { - "type": "string", - "format": "date-time", - "description": "This is used to install patches that were published on or before this given max published date." - } - }, - "description": "Input for InstallPatches on a Windows VM, as directly received by the API" - }, - "LinuxParameters": { - "type": "object", - "properties": { - "classificationsToInclude": { - "type": "array", - "description": "The update classifications to select when installing patches for Linux.", - "items": { - "type": "string", - "enum": [ - "Critical", - "Security", - "Other" - ], - "x-ms-enum": { - "name": "VMGuestPatchClassification_Linux", - "modelAsString": true - } - } - }, - "packageNameMasksToInclude": { - "type": "array", - "description": "packages to include in the patch operation. Format: packageName_packageVersion", - "items": { - "type": "string" - } - }, - "packageNameMasksToExclude": { - "type": "array", - "description": "packages to exclude in the patch operation. Format: packageName_packageVersion", - "items": { - "type": "string" - } - } - }, - "description": "Input for InstallPatches on a Linux VM, as directly received by the API" - }, - "MachineInstallPatchesResult": { - "type": "object", - "properties": { - "status": { - "type": "string", - "readOnly": true, - "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\"", - "enum": [ - "Unknown", - "InProgress", - "Failed", - "Succeeded", - "CompletedWithWarnings" - ], - "x-ms-enum": { - "name": "PatchOperationStatus", - "modelAsString": true - } - }, - "installationActivityId": { - "type": "string", - "readOnly": true, - "description": "The activity ID of the operation that produced this result." - }, - "rebootStatus": { - "type": "string", - "readOnly": true, - "description": "The reboot state of the VM following completion of the operation.", - "enum": [ - "Unknown", - "NotNeeded", - "Required", - "Started", - "Failed", - "Completed" - ], - "x-ms-enum": { - "name": "VMGuestPatchRebootStatus", - "modelAsString": true - } - }, - "maintenanceWindowExceeded": { - "type": "boolean", - "readOnly": true, - "description": "Whether the operation ran out of time before it completed all its intended actions." - }, - "excludedPatchCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The number of patches that were not installed due to the user blocking their installation." - }, - "notSelectedPatchCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria." - }, - "pendingPatchCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true." - }, - "installedPatchCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The number of patches successfully installed." - }, - "failedPatchCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The number of patches that could not be installed due to some issue. See errors for details." - }, - "startDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The UTC timestamp when the operation began." - }, - "lastModifiedDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The UTC timestamp when the operation finished." - }, - "startedBy": { - "type": "string", - "readOnly": true, - "enum": [ - "User", - "Platform" - ], - "x-ms-enum": { - "name": "PatchOperationStartedBy", - "modelAsString": true - }, - "description": "Indicates if operation was triggered by user or by platform." - }, - "patchServiceUsed": { - "type": "string", - "readOnly": true, - "enum": [ - "Unknown", - "WU", - "WU_WSUS", - "YUM", - "APT", - "Zypper" - ], - "x-ms-enum": { - "name": "PatchServiceUsed", - "modelAsString": true - }, - "description": "Specifies the patch service used for the operation." - }, - "osType": { - "type": "string", - "readOnly": true, - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OsType", - "modelAsString": true - }, - "description": "The operating system type of the machine." - }, - "errorDetails": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", - "readOnly": true, - "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." - } - }, - "description": "The result summary of an installation operation." - }, - "MachineRunCommand": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MachineRunCommandProperties", - "description": "Describes Run Command Properties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "description": "Describes a Run Command" - }, - "MachineRunCommandProperties": { - "type": "object", - "properties": { - "source": { - "$ref": "#/definitions/MachineRunCommandScriptSource", - "description": "The source of the run command script." - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/definitions/RunCommandInputParameter" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The parameters used by the script." - }, - "protectedParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/RunCommandInputParameter" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The parameters used by the script." - }, - "asyncExecution": { - "type": "boolean", - "default": false, - "description": "Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete." - }, - "runAsUser": { - "type": "string", - "description": "Specifies the user account on the machine when executing the run command." - }, - "runAsPassword": { - "type": "string", - "description": "Specifies the user account password on the machine when executing the run command.", - "x-ms-secret": true - }, - "timeoutInSeconds": { - "type": "integer", - "format": "int32", - "description": "The timeout in seconds to execute the run command." - }, - "outputBlobUri": { - "type": "string", - "description": "Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. " - }, - "errorBlobUri": { - "type": "string", - "description": "Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter." - }, - "outputBlobManagedIdentity": { - "$ref": "#/definitions/RunCommandManagedIdentity", - "description": "User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " - }, - "errorBlobManagedIdentity": { - "$ref": "#/definitions/RunCommandManagedIdentity", - "description": "User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "instanceView": { - "readOnly": true, - "$ref": "#/definitions/MachineRunCommandInstanceView", - "description": "The machine run command instance view." - } - }, - "description": "Describes the properties of a run command." - }, - "MachineRunCommandScriptSource": { - "type": "object", - "properties": { - "script": { - "type": "string", - "description": "Specifies the script content to be executed on the machine." - }, - "scriptUri": { - "type": "string", - "description": "Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI." - }, - "commandId": { - "type": "string", - "description": "Specifies the commandId of predefined built-in script." - }, - "scriptUriManagedIdentity": { - "$ref": "#/definitions/RunCommandManagedIdentity", - "description": "User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." - } - }, - "description": "Describes the script sources for run command. Use only one of script, scriptUri, commandId." - }, - "MachineRunCommandInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The run command name." - }, - "status": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "type": "string", - "description": "The level code.", - "enum": [ - "Info", - "Warning", - "Error" - ], - "x-ms-enum": { - "name": "StatusLevelTypes", - "modelAsString": true - } - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - } - }, - "description": "Describes the Machine Extension Instance View." - }, - "MachineRunCommandsListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MachineRunCommand" - }, - "description": "The list of run commands" - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." - } - }, - "description": "Describes the Run Commands List Result." - }, - "MachineRunCommandUpdate": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ResourceUpdate" - } - ], - "description": "Describes a Machine Extension Update." - }, - "RunCommandInputParameter": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The run command parameter name." - }, - "value": { - "type": "string", - "description": "The run command parameter value." - } - }, - "required": [ - "name", - "value" - ], - "description": "Describes the properties of a run command parameter." - }, - "RunCommandManagedIdentity": { - "type": "object", - "properties": { - "clientId": { - "type": "string", - "description": "Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided." - }, - "objectId": { - "type": "string", - "description": "Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided." - } - }, - "description": " Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." - } - }, - "parameters": { - "machineNameParameter": { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "pattern": "[a-zA-Z0-9-_\\.]", - "description": "The name of the hybrid machine.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/DELETEExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/DELETEExtension.json deleted file mode 100644 index 1638094b1de6..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/DELETEExtension.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "extensionName": "MMA", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - }, - "204": {} - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/DeleteRunCommand.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/DeleteRunCommand.json deleted file mode 100644 index 25b8b714390e..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/DeleteRunCommand.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "runCommandName": "myRunCommand", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - }, - "204": {} - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ExtensionMetadata_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ExtensionMetadata_Get.json deleted file mode 100644 index 458e1490b9a2..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ExtensionMetadata_Get.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", - "location": "EastUS", - "publisher": "microsoft.azure.monitor", - "extensionType": "azuremonitorlinuxagent", - "version": "1.9.1", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.1", - "properties": { - "version": "1.9.1", - "extensionType": "azuremonitorlinuxagent", - "publisher": "microsoft.azure.monitor" - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ExtensionMetadata_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ExtensionMetadata_List.json deleted file mode 100644 index cbd876be3397..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ExtensionMetadata_List.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", - "location": "EastUS", - "publisher": "microsoft.azure.monitor", - "extensionType": "azuremonitorlinuxagent", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "version": "1.9.1", - "extensionType": "azuremonitorlinuxagent", - "publisher": "microsoft.azure.monitor" - }, - "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.1" - }, - { - "properties": { - "version": "1.9.2", - "extensionType": "azuremonitorlinuxagent", - "publisher": "microsoft.azure.monitor" - }, - "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.2" - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Extensions_Upgrade.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Extensions_Upgrade.json deleted file mode 100644 index 817f6d37cbc9..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Extensions_Upgrade.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview", - "extensionUpgradeParameters": { - "extensionTargets": { - "Microsoft.Compute.CustomScriptExtension": { - "targetVersion": "1.10" - }, - "Microsoft.Azure.Monitoring": { - "targetVersion": "2.0" - } - } - } - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETAgentVersions.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETAgentVersions.json deleted file mode 100644 index f2ee5c14dae5..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETAgentVersions.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "osType": "myOsType", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "agentVersion": "1.26", - "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", - "osType": "myOsType" - }, - { - "agentVersion": "1.27", - "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", - "osType": "myOsType" - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETExtension.json deleted file mode 100644 index c000528229b0..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETExtension.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "extensionName": "CustomScriptExtension", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", - "name": "CustomScriptExtension", - "type": "Microsoft.HybridCompute/machines/extensions", - "location": "eastus2euap", - "properties": { - "publisher": "Microsoft.Compute", - "type": "string", - "typeHandlerVersion": "1.10.3", - "autoUpgradeMinorVersion": false, - "settings": { - "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" - }, - "protectedSettings": {}, - "provisioningState": "Succeeded", - "instanceView": { - "name": "CustomScriptExtension", - "type": "CustomScriptExtension", - "typeHandlerVersion": "1.10.3", - "status": { - "code": "success", - "level": "Information", - "displayStatus": "Provisioning succeeded", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2019-08-08T20:42:10.999Z" - } - } - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETLatestAgentVersion.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETLatestAgentVersion.json deleted file mode 100644 index 3660912a5883..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETLatestAgentVersion.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "osType": "myOsType", - "version": "1.27", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "agentVersion": "1.27", - "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", - "osType": "myOsType" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETNetworkProfile.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETNetworkProfile.json deleted file mode 100644 index e86c48241a91..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GETNetworkProfile.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "networkInterfaces": [ - { - "ipAddresses": [ - { - "address": "192.168.12.345", - "ipAddressVersion": "IPv4", - "subnet": { - "addressPrefix": "192.168.12.0/24" - } - } - ] - }, - { - "ipAddresses": [ - { - "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", - "ipAddressVersion": "IPv6", - "subnet": { - "addressPrefix": "1001:0:34aa:5000::/64" - } - } - ] - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GetHybridIdentityMetadata.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GetHybridIdentityMetadata.json deleted file mode 100644 index fc60004e5ae5..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GetHybridIdentityMetadata.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "machineName": "ContosoVm", - "metadataName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoVm/hybridIdentityMetadata/default", - "name": "testItem", - "type": "Microsoft.HybridCompute/machines/hybridIdentityMetadata", - "properties": { - "vmId": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", - "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2", - "identity": { - "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", - "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d", - "type": "SystemAssigned" - } - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GetRunCommand.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GetRunCommand.json deleted file mode 100644 index 9527819b5927..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/GetRunCommand.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "runCommandName": "myRunCommand", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", - "name": "myRunCommand", - "type": "Microsoft.HybridCompute/machines/runcommands", - "location": "eastus2", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "source": { - "script": "Write-Host Hello World!" - }, - "parameters": [ - { - "name": "param1", - "value": "value1" - }, - { - "name": "param2", - "value": "value2" - } - ], - "protectedParameters": [], - "asyncExecution": false, - "runAsUser": "user1", - "timeoutInSeconds": 3600, - "provisioningState": "Succeeded", - "instanceView": { - "name": "myRunCommand", - "status": { - "code": "success", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2019-08-08T20:42:10.999Z" - } - } - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json deleted file mode 100644 index e062b0eab7c8..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", - "resourceGroupName": "testrg", - "machineName": "ContosoVm" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoVm/hybridIdentityMetadata/default", - "name": "testItem", - "type": "Microsoft.HybridCompute/machines/hybridIdentityMetadata", - "properties": { - "vmId": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", - "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2", - "identity": { - "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", - "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d", - "type": "SystemAssigned" - } - } - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/LISTExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/LISTExtension.json deleted file mode 100644 index e1f17f9a3296..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/LISTExtension.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", - "name": "CustomScriptExtension", - "location": "eastus2euap", - "type": "Microsoft.HybridCompute/machines/extensions", - "properties": { - "publisher": "Microsoft.Compute", - "type": "CustomScriptExtension", - "typeHandlerVersion": "1.10.3", - "autoUpgradeMinorVersion": false, - "settings": { - "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" - }, - "provisioningState": "Succeeded", - "instanceView": { - "name": "CustomScriptExtension", - "type": "CustomScriptExtension", - "typeHandlerVersion": "1.10.3", - "status": { - "code": "success", - "level": "Information", - "displayStatus": "Provisioning succeeded", - "message": "formattedMessage: Finished executing command, StdOut: , StdErr: ", - "time": "2020-08-13T17:18:57.405Z" - } - } - } - }, - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/winosupdateextension", - "name": "winosupdateextension", - "location": "eastus2euap", - "type": "Microsoft.HybridCompute/machines/extensions", - "properties": { - "publisher": "microsoft.softwareupdatemanagement.test", - "type": "windowsosupdateextension", - "typeHandlerVersion": "1.0.0.0", - "autoUpgradeMinorVersion": false, - "settings": {}, - "provisioningState": "Creating", - "instanceView": { - "name": "winosupdateextension", - "type": "windowsosupdateextension", - "typeHandlerVersion": "1.0.0.0", - "status": {} - } - } - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ListRunCommand.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ListRunCommand.json deleted file mode 100644 index 9a406faf9575..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/ListRunCommand.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_1", - "name": "myRunCommand_1", - "location": "eastus2", - "type": "Microsoft.HybridCompute/machines/runcommands", - "properties": { - "source": { - "script": "Write-Host Hello World!" - }, - "parameters": [ - { - "name": "param1", - "value": "value1" - }, - { - "name": "param2", - "value": "value2" - } - ], - "protectedParameters": [], - "asyncExecution": false, - "runAsUser": "user1", - "timeoutInSeconds": 3600, - "provisioningState": "Succeeded", - "instanceView": { - "name": "myRunCommand_1", - "status": { - "code": "success", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2019-08-08T20:42:10.999Z" - } - } - } - }, - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand_2", - "name": "myRunCommand_2", - "location": "eastus2", - "type": "Microsoft.HybridCompute/machines/runcommands", - "properties": { - "source": { - "script": "Get-Process | Where-Object { $_.CPU -gt 10000 }" - }, - "parameters": [], - "protectedParameters": [], - "asyncExecution": false, - "runAsUser": "userA", - "timeoutInSeconds": 100, - "provisioningState": "Succeeded", - "instanceView": { - "name": "myRunCommand_2", - "status": { - "code": "success", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2019-08-08T20:42:10.999Z" - } - } - } - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/MachineAssessPatches.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/MachineAssessPatches.json deleted file mode 100644 index c936f2408444..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/MachineAssessPatches.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroupName", - "name": "myMachineName", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "status": "Succeeded", - "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", - "rebootPending": true, - "startDateTime": "2021-08-22T02:15:20.9340000Z", - "lastModifiedDateTime": "2021-08-22T02:16:06.9740000Z", - "availablePatchCountByClassification": { - "security": 0, - "updateRollup": 1, - "featurePack": 0, - "servicePack": 0, - "definition": 0, - "critical": 0, - "updates": 1, - "tools": 0 - }, - "startedBy": "User", - "osType": "Windows", - "errorDetails": null - } - }, - "202": { - "headers": { - "Location": "eastus2euap" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/MachineInstallPatches.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/MachineInstallPatches.json deleted file mode 100644 index ad3a25feb725..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/MachineInstallPatches.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroupName", - "name": "myMachineName", - "api-version": "2023-04-25-preview", - "installPatchesInput": { - "maximumDuration": "PT4H", - "rebootSetting": "IfRequired", - "windowsParameters": { - "classificationsToInclude": [ - "Critical", - "Security" - ], - "maxPatchPublishDate": "2021-08-19T02:36:43.0539904+00:00" - } - } - }, - "responses": { - "200": { - "body": { - "status": "Succeeded", - "installationActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", - "rebootStatus": "Completed", - "maintenanceWindowExceeded": false, - "excludedPatchCount": 0, - "notSelectedPatchCount": 0, - "pendingPatchCount": 2, - "installedPatchCount": 3, - "failedPatchCount": 0, - "startDateTime": "2021-08-22T02:15:06.9740000Z", - "lastModifiedDateTime": "2021-08-22T02:16:06.9740000Z", - "startedBy": "User", - "osType": "Windows", - "errorDetails": null - } - }, - "202": { - "headers": { - "Location": "eastus2euap" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_CreateOrUpdate.json deleted file mode 100644 index a7e957eff034..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_CreateOrUpdate.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview", - "parameters": { - "location": "eastus2euap", - "properties": { - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond" - }, - "clientPublicKey": "string", - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - }, - "identity": { - "type": "SystemAssigned" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", - "name": "myMachine", - "location": "eastus2euap", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "string", - "tenantId": "string" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "vmUuid": null, - "osSku": null, - "domainName": null, - "adFqdn": null, - "dnsFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - } - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond", - "city": "redmond", - "district": null, - "countryOrRegion": "usa" - }, - "clientPublicKey": "string", - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "mssqlDiscovered": "false", - "detectedProperties": { - "cloudprovider": "N/A", - "manufacturer": "Microsoft Corporation", - "model": "Virtual Machine" - }, - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Delete.json deleted file mode 100644 index b7636114f27b..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Get.json deleted file mode 100644 index 20d780a2c719..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Get.json +++ /dev/null @@ -1,125 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", - "name": "myMachine", - "location": "eastus2euap", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "string", - "tenantId": "string" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "vmUuid": null, - "osSku": null, - "domainName": null, - "adFqdn": null, - "dnsFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - } - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond", - "city": "redmond", - "district": null, - "countryOrRegion": "usa" - }, - "clientPublicKey": "string", - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "mssqlDiscovered": "false", - "detectedProperties": { - "cloudprovider": "N/A", - "manufacturer": "Microsoft Corporation", - "model": "Virtual Machine" - }, - "agentConfiguration": { - "proxyUrl": "https://test.test", - "incomingConnectionsPorts": [ - "22", - "23" - ], - "extensionsAllowList": null, - "extensionsBlockList": null, - "proxyBypass": [ - "proxy1", - "proxy2" - ], - "extensionsEnabled": "true", - "guestConfigurationEnabled": "true", - "configMode": "full" - }, - "serviceStatuses": { - "extensionService": { - "status": "Running", - "startupType": "Automatic" - }, - "guestConfigurationService": { - "status": "Running", - "startupType": "Automatic" - } - }, - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", - "networkProfile": { - "networkInterfaces": [ - { - "ipAddresses": [ - { - "address": "192.168.12.345", - "ipAddressVersion": "IPv4", - "subnet": { - "addressPrefix": "192.168.12.0/24" - } - } - ] - }, - { - "ipAddresses": [ - { - "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", - "ipAddressVersion": "IPv6", - "subnet": { - "addressPrefix": "1001:0:34aa:5000::/64" - } - } - ] - } - ] - } - }, - "resources": [] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_ListByResourceGroup.json deleted file mode 100644 index cfae35caee5a..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_ListByResourceGroup.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", - "name": "myMachine", - "location": "eastus2euap", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "f7a068cc-b0b8-46e8-a203-22f301a62a8f", - "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "vmUuid": null, - "osSku": null, - "domainName": null, - "adFqdn": null, - "dnsFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - } - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond" - }, - "clientPublicKey": "string", - "parentClusterResourceId": null, - "mssqlDiscovered": "false", - "detectedProperties": { - "cloudprovider": "N/A", - "manufacturer": "Microsoft Corporation", - "model": "Virtual Machine" - }, - "agentConfiguration": { - "proxyUrl": "https://test.test", - "incomingConnectionsPorts": [ - "22", - "23" - ], - "extensionsAllowList": null, - "extensionsBlockList": null, - "proxyBypass": [ - "proxy1", - "proxy2" - ], - "extensionsEnabled": "true", - "guestConfigurationEnabled": "true", - "configMode": "full" - }, - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - } - }, - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine2", - "name": "myMachine2", - "location": "westus2", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", - "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - } - }, - "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond" - }, - "clientPublicKey": "string", - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "mssqlDiscovered": "true", - "detectedProperties": { - "cloudprovider": "N/A", - "manufacturer": "Microsoft Corporation", - "model": "Surfacebook" - }, - "agentConfiguration": { - "proxyUrl": "https://test.test", - "incomingConnectionsPorts": [ - "22", - "23" - ], - "extensionsAllowList": null, - "extensionsBlockList": null, - "proxyBypass": [ - "proxy1", - "proxy2" - ], - "extensionsEnabled": "true", - "guestConfigurationEnabled": "true", - "configMode": "full" - }, - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_ListBySubscription.json deleted file mode 100644 index 92c05f76f87f..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_ListBySubscription.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", - "name": "myMachine", - "location": "eastus2euap", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "string", - "tenantId": "string" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "vmUuid": null, - "osSku": null, - "domainName": null, - "adFqdn": null, - "dnsFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - } - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond" - }, - "clientPublicKey": "string", - "parentClusterResourceId": null, - "mssqlDiscovered": "false", - "detectedProperties": { - "cloudprovider": "N/A", - "manufacturer": "Microsoft Corporation", - "model": "Virtual Machine" - }, - "agentConfiguration": { - "proxyUrl": "https://test.test", - "incomingConnectionsPorts": [ - "22", - "23" - ], - "extensionsAllowList": null, - "extensionsBlockList": null, - "proxyBypass": [ - "proxy1", - "proxy2" - ], - "extensionsEnabled": "true", - "guestConfigurationEnabled": "true", - "configMode": "full" - }, - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - } - }, - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.HybridCompute/machines/myMachine2", - "name": "myMachine2", - "location": "westus2", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", - "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": null, - "patchMode": null - } - } - }, - "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond" - }, - "clientPublicKey": "string", - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "mssqlDiscovered": "true", - "detectedProperties": { - "cloudprovider": "N/A", - "manufacturer": "Microsoft Corporation", - "model": "Surfacebook" - }, - "agentConfiguration": { - "proxyUrl": "https://test.test", - "incomingConnectionsPorts": [ - "22", - "23" - ], - "extensionsAllowList": null, - "extensionsBlockList": null, - "proxyBypass": [ - "proxy1", - "proxy2" - ], - "extensionsEnabled": "true", - "guestConfigurationEnabled": "true", - "configMode": "full" - } - } - } - ], - "nextLink": "string" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Update.json deleted file mode 100644 index 8ec18c5096a7..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Machines_Update.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "api-version": "2023-04-25-preview", - "location": "eastus2euap", - "kind": null, - "parameters": { - "properties": { - "locationData": { - "name": "Redmond" - }, - "osProfile": { - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": "ImageDefault", - "patchMode": "Manual" - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": "ImageDefault", - "patchMode": "Manual" - } - } - }, - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - }, - "identity": { - "type": "SystemAssigned" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", - "name": "myMachine", - "location": "eastus2euap", - "tags": null, - "identity": { - "type": "SystemAssigned", - "principalId": "string", - "tenantId": "string" - }, - "type": "Microsoft.HybridCompute/machines", - "kind": null, - "properties": { - "provisioningState": "Succeeded", - "agentVersion": null, - "status": null, - "lastStatusChange": null, - "errorDetails": null, - "displayName": null, - "machineFqdn": null, - "vmUuid": null, - "osSku": null, - "domainName": null, - "adFqdn": null, - "dnsFqdn": null, - "osVersion": null, - "osType": null, - "osProfile": { - "computerName": null, - "windowsConfiguration": { - "patchSettings": { - "assessmentMode": "ImageDefault", - "patchMode": "Manual" - } - }, - "linuxConfiguration": { - "patchSettings": { - "assessmentMode": "ImageDefault", - "patchMode": "Manual" - } - } - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "locationData": { - "name": "Redmond" - }, - "clientPublicKey": "string", - "parentClusterResourceId": "{AzureStackHCIResourceId}", - "detectedProperties": null, - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Operations_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Operations_List.json deleted file mode 100644 index 03ac8adfebe4..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/Operations_List.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "origin": "user,system", - "name": "Microsoft.HybridCompute/operations/read", - "display": { - "operation": "Read all Operations", - "resource": "Microsoft.HybridCompute Resource Provider", - "description": "Read all Operations for Azure Arc for Servers", - "provider": "Microsoft HybridCompute" - }, - "isDataAction": true - }, - { - "origin": "user,system", - "name": "Microsoft.HybridCompute/register/action", - "display": { - "operation": "Register Subscription for Azure Arc for Servers", - "resource": "Microsoft.HybridCompute Resource Provider", - "description": "Registers the subscription for the Microsoft.HybridCompute Resource Provider", - "provider": "Microsoft HybridCompute" - }, - "isDataAction": true - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PUTExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PUTExtension.json deleted file mode 100644 index 78ce9420e6e3..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PUTExtension.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "extensionName": "CustomScriptExtension", - "api-version": "2023-04-25-preview", - "extensionParameters": { - "location": "eastus2euap", - "properties": { - "publisher": "Microsoft.Compute", - "typeHandlerVersion": "1.10", - "type": "CustomScriptExtension", - "settings": { - "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", - "name": "CustomScriptExtension", - "type": "Microsoft.HybridCompute/machines/extensions", - "location": "eastus2euap", - "properties": { - "publisher": "Microsoft.Compute", - "type": "string", - "typeHandlerVersion": "1.10.3", - "autoUpgradeMinorVersion": false, - "settings": { - "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" - }, - "protectedSettings": {}, - "provisioningState": "Succeeded", - "instanceView": { - "name": "CustomScriptExtension", - "type": "CustomScriptExtension", - "typeHandlerVersion": "1.10.3", - "status": { - "code": "success", - "level": "Information", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2020-08-08T20:42:10.999Z" - } - } - } - } - }, - "202": {} - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionDelete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionDelete.json deleted file mode 100644 index 64a8a4b09fa1..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionDelete.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "scopeName": "myPrivateLinkScope", - "privateEndpointConnectionName": "private-endpoint-connection-name", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - }, - "204": {} - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionGet.json deleted file mode 100644 index 6e9db485ba93..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionGet.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "scopeName": "myPrivateLinkScope", - "privateEndpointConnectionName": "private-endpoint-connection-name", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - }, - "groupIds": [ - "hybridcompute" - ] - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionList.json deleted file mode 100644 index b044db15efdb..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionList.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "scopeName": "myPrivateLinkScope", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - }, - "groupIds": [ - "hybridcompute" - ] - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", - "name": "private-endpoint-connection-name-2", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" - }, - "privateLinkServiceConnectionState": { - "status": "Pending", - "description": "Please approve my connection.", - "actionsRequired": "None" - }, - "groupIds": [ - "hybridcompute" - ] - } - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionUpdate.json deleted file mode 100644 index 114b57086ea3..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateEndpointConnectionUpdate.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "scopeName": "myPrivateLinkScope", - "privateEndpointConnectionName": "private-endpoint-connection-name", - "api-version": "2023-04-25-preview", - "parameters": { - "properties": { - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Approved by johndoe@contoso.com" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Approved by johndoe@contoso.com", - "actionsRequired": "None" - }, - "groupIds": [ - "hybridcompute" - ] - } - } - }, - "202": {} - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json deleted file mode 100644 index 09a57f23e338..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "scopeName": "myPrivateLinkScope", - "api-version": "2023-04-25-preview", - "groupName": "hybridcompute" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", - "name": "hybridcompute", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", - "properties": { - "groupId": "hybridcompute", - "requiredMembers": [ - "HybridCompute.Server", - "HybridCompute.K8sConfiguration", - "GuestConfig.DP" - ], - "requiredZoneNames": [ - "privatelink.his.arc.azure.com", - "privatelink.kubernetesconfiguration.azure.com", - "privatelink.Guestconfiguration.azure.com" - ] - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json deleted file mode 100644 index 984a72cba81d..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myResourceGroup", - "scopeName": "myPrivateLinkScope", - "api-version": "2023-04-25-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", - "name": "hybridcompute", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", - "properties": { - "groupId": "hybridcompute", - "requiredMembers": [ - "HybridCompute.ServerDP", - "HybridCompute.K8sConfigurationDP", - "HybridCompute.GuestConfigDP" - ], - "requiredZoneNames": [ - "privatelink.his.arc.azure.com", - "privatelink.kubernetesconfiguration.azure.com", - "privatelink.Guestconfiguration.azure.com" - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesCreate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesCreate.json deleted file mode 100644 index 9efb3e288933..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesCreate.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "resourceGroupName": "my-resource-group", - "scopeName": "my-privatelinkscope", - "parameters": { - "location": "westus" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesDelete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesDelete.json deleted file mode 100644 index e48ab64c7983..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesDelete.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "resourceGroupName": "my-resource-group", - "scopeName": "my-privatelinkscope" - }, - "responses": { - "200": {}, - "204": {}, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGet.json deleted file mode 100644 index 70124b6bf13d..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGet.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "resourceGroupName": "my-resource-group", - "scopeName": "my-privatelinkscope" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGetValidation.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGetValidation.json deleted file mode 100644 index 90317bdb0ccb..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGetValidation.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "location": "wus2", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "publicNetworkAccess": "Disabled", - "connectionDetails": [ - { - "id": "id", - "privateIpAddress": "ip", - "linkIdentifier": "linkId", - "groupId": "groupId", - "memberName": "memberName" - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGetValidationForMachine.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGetValidationForMachine.json deleted file mode 100644 index 9be50f662c20..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesGetValidationForMachine.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "location": "wus2", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "resourceGroupName": "my-resource-group", - "machineName": "machineName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "publicNetworkAccess": "Disabled", - "connectionDetails": [ - { - "id": "id", - "privateIpAddress": "ip", - "linkIdentifier": "linkId", - "groupId": "groupId", - "memberName": "memberName" - } - ] - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesList.json deleted file mode 100644 index e654989888c1..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesList.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled" - } - }, - { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", - "name": "my-other-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesListByResourceGroup.json deleted file mode 100644 index f4f6aca11497..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesListByResourceGroup.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "resourceGroupName": "my-resource-group" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - }, - { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", - "name": "my-other-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": {}, - "properties": { - "privateLinkScopeId": "a5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesUpdate.json deleted file mode 100644 index 2433d530401c..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesUpdate.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", - "resourceGroupName": "my-resource-group", - "scopeName": "my-privatelinkscope", - "parameters": { - "location": "westus", - "tags": { - "Tag1": "Value1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": { - "Tag1": "Value1" - }, - "properties": { - "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": { - "Tag1": "Value1" - }, - "properties": { - "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesUpdateTagsOnly.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesUpdateTagsOnly.json deleted file mode 100644 index cec39f05e87a..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PrivateLinkScopesUpdateTagsOnly.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-25-preview", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "scopeName": "my-privatelinkscope", - "PrivateLinkScopeTags": { - "tags": { - "Tag1": "Value1", - "Tag2": "Value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", - "name": "my-privatelinkscope", - "type": "Microsoft.HybridCompute/privateLinkScopes", - "location": "westus", - "tags": { - "Tag1": "Value1", - "Tag2": "Value2" - }, - "properties": { - "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", - "provisioningState": "Succeeded", - "publicNetworkAccess": "Disabled", - "privateEndpointConnections": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", - "name": "private-endpoint-connection-name", - "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", - "properties": { - "provisioningState": "Succeeded", - "privateEndpoint": { - "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" - }, - "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "Auto-approved", - "actionsRequired": "None" - } - } - } - ] - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PutRunCommand.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PutRunCommand.json deleted file mode 100644 index 682ba599e133..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/PutRunCommand.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "runCommandName": "myRunCommand", - "api-version": "2023-04-25-preview", - "runCommandProperties": { - "location": "eastus2", - "properties": { - "source": { - "script": "Write-Host Hello World!" - }, - "parameters": [ - { - "name": "param1", - "value": "value1" - }, - { - "name": "param2", - "value": "value2" - } - ], - "asyncExecution": false, - "runAsUser": "user1", - "runAsPassword": "", - "timeoutInSeconds": 3600, - "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", - "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt?sp=racw&st=2022-10-07T19:40:21Z&se=2022-10-08T03:40:21Z&spr=https&sv=2021-06-08&sr=b&sig=Yh7B%2Fy83olbYBdfsfbUREvd7ol8Dq5EVP3lAO4Kj4xDcN8%3D" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", - "name": "myRunCommand", - "type": "Microsoft.HybridCompute/machines/runcommands", - "location": "eastus2", - "properties": { - "source": { - "script": "Write-Host Hello World!" - }, - "parameters": [ - { - "name": "param1", - "value": "value1" - }, - { - "name": "param2", - "value": "value2" - } - ], - "asyncExecution": false, - "runAsUser": "user1", - "timeoutInSeconds": 3600, - "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", - "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt?sp=racw&st=2022-10-07T19:40:21Z&se=2022-10-08T03:40:21Z&spr=https&sv=2021-06-08&sr=b&sig=Yh7B%2Fy83olbYBdfsfbUREvd7ol8Dq5EVP3lAO4Kj4xDcN8%3D", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - }, - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", - "name": "myRunCommand", - "type": "Microsoft.HybridCompute/machines/runcommands", - "location": "eastus2", - "properties": { - "source": { - "script": "Write-Host Hello World!" - }, - "parameters": [ - { - "name": "param1", - "value": "value1" - }, - { - "name": "param2", - "value": "value2" - } - ], - "asyncExecution": false, - "runAsUser": "user1", - "timeoutInSeconds": 3600, - "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", - "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt?sp=racw&st=2022-10-07T19:40:21Z&se=2022-10-08T03:40:21Z&spr=https&sv=2021-06-08&sr=b&sig=Yh7B%2Fy83olbYBdfsfbUREvd7ol8Dq5EVP3lAO4Kj4xDcN8%3D", - "provisioningState": "Creating" - } - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/UpdateExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/UpdateExtension.json deleted file mode 100644 index bf3482139dc0..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/UpdateExtension.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "extensionName": "CustomScriptExtension", - "api-version": "2023-04-25-preview", - "extensionParameters": { - "properties": { - "publisher": "Microsoft.Compute", - "typeHandlerVersion": "1.10", - "enableAutomaticUpgrade": true, - "type": "CustomScriptExtension", - "settings": { - "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", - "name": "CustomScriptExtension", - "type": "Microsoft.HybridCompute/machines/extensions", - "location": "eastus2euap", - "properties": { - "publisher": "Microsoft.Compute", - "type": "string", - "typeHandlerVersion": "1.10.3", - "enableAutomaticUpgrade": true, - "autoUpgradeMinorVersion": false, - "settings": { - "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" - }, - "protectedSettings": {}, - "provisioningState": "Succeeded", - "instanceView": { - "name": "CustomScriptExtension", - "type": "CustomScriptExtension", - "typeHandlerVersion": "1.10.3", - "status": { - "code": "success", - "level": "Information", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2020-01-08T20:42:10.999Z" - } - } - } - } - }, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/UpdateRunCommand.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/UpdateRunCommand.json deleted file mode 100644 index 1035312882f8..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/examples/UpdateRunCommand.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "machineName": "myMachine", - "runCommandName": "myRunCommand", - "api-version": "2023-04-25-preview", - "runCommandProperties": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand", - "name": "myRunCommand", - "type": "Microsoft.HybridCompute/machines/runcommands", - "location": "eastus2", - "properties": { - "source": { - "script": "Write-Host Hello World!" - }, - "parameters": [ - { - "name": "param1", - "value": "value1" - }, - { - "name": "param2", - "value": "value2" - } - ], - "asyncExecution": false, - "runAsUser": "user1", - "timeoutInSeconds": 3600, - "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", - "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt?sp=racw&st=2022-10-07T19:40:21Z&se=2022-10-08T03:40:21Z&spr=https&sv=2021-06-08&sr=b&sig=Yh7B%2Fy83olbYBdfsfbUREvd7ol8Dq5EVP3lAO4Kj4xDcN8%3D", - "provisioningState": "Succeeded", - "instanceView": { - "name": "myRunCommand", - "status": { - "code": "success", - "level": "Info", - "displayStatus": "Provisioning succeeded", - "message": "Finished executing command, StdOut: , StdErr:", - "time": "2019-08-08T20:42:10.999Z" - } - } - } - } - }, - "202": { - "headers": { - "Location": "{callbackUrl}", - "Retry-After": 200, - "Azure-AsyncOperation": "{callbackUri}" - } - } - } -} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json deleted file mode 100644 index 6879c0591500..000000000000 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json +++ /dev/null @@ -1,1130 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "HybridComputeManagementClient", - "x-ms-code-generation-settings": { - "name": "HybridComputeManagementClient" - }, - "description": "Azure Arc( Servers and K8s Clusters) API reference for Private Link's Scopes management.", - "version": "2023-04-25-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes": { - "get": { - "description": "Gets a list of all Azure Arc PrivateLinkScopes within a subscription.", - "operationId": "PrivateLinkScopes_List", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopesList.json": { - "$ref": "./examples/PrivateLinkScopesList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes": { - "get": { - "description": "Gets a list of Azure Arc PrivateLinkScopes within a resource group.", - "operationId": "PrivateLinkScopes_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeListByResourceGroup": { - "$ref": "./examples/PrivateLinkScopesListByResourceGroup.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}": { - "delete": { - "description": "Deletes a Azure Arc PrivateLinkScope.", - "operationId": "PrivateLinkScopes_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successful request when deleting an Azure Arc PrivateLinkScope." - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "204": { - "description": "The specified PrivateLinkScope does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "PrivateLinkScopesDelete": { - "$ref": "./examples/PrivateLinkScopesDelete.json" - } - } - }, - "get": { - "description": "Returns a Azure Arc PrivateLinkScope.", - "operationId": "PrivateLinkScopes_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Azure Arc PrivateLinkScope definition.", - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScope" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeGet": { - "$ref": "./examples/PrivateLinkScopesGet.json" - } - } - }, - "put": { - "description": "Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", - "operationId": "PrivateLinkScopes_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "parameters", - "description": "Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScope" - } - } - ], - "responses": { - "200": { - "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned.", - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScope" - } - }, - "201": { - "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScope" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeCreate": { - "$ref": "./examples/PrivateLinkScopesCreate.json" - }, - "PrivateLinkScopeUpdate": { - "$ref": "./examples/PrivateLinkScopesUpdate.json" - } - } - }, - "patch": { - "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", - "operationId": "PrivateLinkScopes_UpdateTags", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "PrivateLinkScopeTags", - "description": "Updated tag information to set into the PrivateLinkScope instance.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TagsResource" - } - } - ], - "responses": { - "200": { - "description": "Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", - "schema": { - "$ref": "#/definitions/HybridComputePrivateLinkScope" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeUpdateTagsOnly": { - "$ref": "./examples/PrivateLinkScopesUpdateTagsOnly.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources": { - "get": { - "tags": [ - "PrivateLinkResources" - ], - "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", - "operationId": "PrivateLinkResources_ListByPrivateLinkScope", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved private link resources.", - "schema": { - "$ref": "#/definitions/PrivateLinkResourceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private endpoint connection.": { - "$ref": "./examples/PrivateLinkScopePrivateLinkResourceListGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { - "get": { - "tags": [ - "PrivateLinkResources" - ], - "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", - "operationId": "PrivateLinkResources_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "$ref": "#/parameters/GroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a specified private link resource.", - "schema": { - "$ref": "#/definitions/PrivateLinkResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private endpoint connection.": { - "$ref": "./examples/PrivateLinkScopePrivateLinkResourceGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Gets a private endpoint connection.", - "operationId": "PrivateEndpointConnections_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a specified private endpoint connection.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets private endpoint connection.": { - "$ref": "./examples/PrivateEndpointConnectionGet.json" - } - } - }, - "put": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Approve or reject a private endpoint connection with a given name.", - "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - } - ], - "responses": { - "200": { - "description": "Successfully approved or rejected private endpoint connection.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Approve or reject a private endpoint connection with a given name.": { - "$ref": "./examples/PrivateEndpointConnectionUpdate.json" - } - } - }, - "delete": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Deletes a private endpoint connection with a given name.", - "operationId": "PrivateEndpointConnections_Delete", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successfully deleted private endpoint connection." - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "The URL of the resource used to check the status of the asynchronous operation.", - "type": "string" - }, - "Retry-After": { - "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", - "type": "integer", - "format": "int32" - }, - "Azure-AsyncOperation": { - "description": "The URI to poll for completion status.", - "type": "string" - } - } - }, - "204": { - "description": "Private endpoint connection does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes a private endpoint connection with a given name.": { - "$ref": "./examples/PrivateEndpointConnectionDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Gets all private endpoint connections on a private link scope.", - "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeName" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved private endpoint connections.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets list of private endpoint connections on a private link scope.": { - "$ref": "./examples/PrivateEndpointConnectionList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}": { - "get": { - "description": "Returns a Azure Arc PrivateLinkScope's validation details.", - "operationId": "PrivateLinkScopes_GetValidationDetails", - "parameters": [ - { - "$ref": "#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PrivateLinkScopeId" - } - ], - "responses": { - "200": { - "description": "Azure Arc PrivateLinkScope validation details definition.", - "schema": { - "$ref": "#/definitions/PrivateLinkScopeValidationDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeGet": { - "$ref": "./examples/PrivateLinkScopesGetValidation.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current": { - "get": { - "description": "Returns a Azure Arc PrivateLinkScope's validation details for a given machine.", - "operationId": "PrivateLinkScopes_GetValidationDetailsForMachine", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/MachineNameParameter" - } - ], - "responses": { - "200": { - "description": "Azure Arc PrivateLinkScope validation details definition.", - "schema": { - "$ref": "#/definitions/PrivateLinkScopeValidationDetails" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PrivateLinkScopeGet": { - "$ref": "./examples/PrivateLinkScopesGetValidationForMachine.json" - } - } - } - } - }, - "definitions": { - "PrivateLinkScopesResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "name": { - "type": "string", - "description": "Azure resource name", - "readOnly": true - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "location": { - "type": "string", - "description": "Resource location", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "An azure resource object" - }, - "TagsResource": { - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance." - }, - "HybridComputePrivateLinkScope": { - "type": "object", - "properties": { - "properties": { - "description": "Properties that define a Azure Arc PrivateLinkScope resource.", - "$ref": "#/definitions/HybridComputePrivateLinkScopeProperties" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "#/definitions/PrivateLinkScopesResource" - } - ], - "description": "An Azure Arc PrivateLinkScope definition." - }, - "PrivateLinkScopeValidationDetails": { - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "publicNetworkAccess": { - "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", - "$ref": "#/definitions/PublicNetworkAccessType" - }, - "connectionDetails": { - "type": "array", - "description": "List of Private Endpoint Connection details.", - "items": { - "$ref": "#/definitions/ConnectionDetail" - } - } - } - }, - "ConnectionDetail": { - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "privateIpAddress": { - "type": "string", - "readOnly": true, - "description": "The private endpoint connection private ip address" - }, - "linkIdentifier": { - "type": "string", - "readOnly": true, - "description": "The private endpoint connection link identifier" - }, - "groupId": { - "type": "string", - "readOnly": true, - "description": "The private endpoint connection group id" - }, - "memberName": { - "type": "string", - "readOnly": true, - "description": "The private endpoint connection member name" - } - } - }, - "HybridComputePrivateLinkScopeProperties": { - "type": "object", - "description": "Properties that define a Azure Arc PrivateLinkScope resource.", - "properties": { - "publicNetworkAccess": { - "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", - "$ref": "#/definitions/PublicNetworkAccessType" - }, - "provisioningState": { - "type": "string", - "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", - "readOnly": true - }, - "privateLinkScopeId": { - "readOnly": true, - "description": "The Guid id of the private link scope.", - "type": "string" - }, - "privateEndpointConnections": { - "readOnly": true, - "description": "The collection of associated Private Endpoint Connections.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnectionDataModel" - } - } - } - }, - "HybridComputePrivateLinkScopeListResult": { - "type": "object", - "description": "Describes the list of Azure Arc PrivateLinkScope resources.", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of Azure Arc PrivateLinkScope definitions.", - "items": { - "$ref": "#/definitions/HybridComputePrivateLinkScope" - } - }, - "nextLink": { - "type": "string", - "description": "The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." - } - } - }, - "PrivateLinkResourceListResult": { - "type": "object", - "description": "A list of private link resources", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "PrivateLinkResource": { - "type": "object", - "description": "A private link resource", - "properties": { - "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "description": "Resource properties." - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "PrivateLinkResourceProperties": { - "type": "object", - "description": "Properties of a private link resource.", - "properties": { - "groupId": { - "description": "The private link resource group id.", - "type": "string", - "readOnly": true - }, - "requiredMembers": { - "description": "The private link resource required member names.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "requiredZoneNames": { - "description": "Required DNS zone names of the the private link resource.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - } - } - }, - "PrivateEndpointConnectionDataModel": { - "type": "object", - "description": "The Data Model for a Private Endpoint Connection associated with a Private Link Scope", - "properties": { - "id": { - "description": "The ARM Resource Id of the Private Endpoint.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The Name of the Private Endpoint.", - "type": "string", - "readOnly": true - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "The Private Endpoint Connection properties." - } - } - }, - "PrivateEndpointConnectionProperties": { - "type": "object", - "description": "Properties of a private endpoint connection.", - "properties": { - "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpointProperty", - "description": "Private endpoint which the connection belongs to." - }, - "privateLinkServiceConnectionState": { - "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", - "description": "Connection state of the private endpoint connection." - }, - "provisioningState": { - "description": "State of the private endpoint connection.", - "type": "string", - "readOnly": true - }, - "groupIds": { - "description": "List of group IDs.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - } - } - }, - "PrivateEndpointProperty": { - "type": "object", - "description": "Private endpoint which the connection belongs to.", - "properties": { - "id": { - "description": "Resource id of the private endpoint.", - "type": "string" - } - } - }, - "PrivateLinkServiceConnectionStateProperty": { - "type": "object", - "description": "State of the private endpoint connection.", - "required": [ - "status", - "description" - ], - "properties": { - "status": { - "description": "The private link service connection status.", - "type": "string" - }, - "description": { - "description": "The private link service connection description.", - "type": "string" - }, - "actionsRequired": { - "description": "The actions required for private link service connection.", - "type": "string", - "readOnly": true - } - } - }, - "PrivateEndpointConnection": { - "type": "object", - "description": "A private endpoint connection", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "Resource properties." - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" - } - } - }, - "PrivateEndpointConnectionListResult": { - "type": "object", - "description": "A list of private endpoint connections.", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "PublicNetworkAccessType": { - "type": "string", - "description": "The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).", - "default": "Disabled", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "PublicNetworkAccessType", - "modelAsString": true, - "values": [ - { - "value": "Enabled", - "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." - }, - { - "value": "Disabled", - "description": "Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link." - } - ] - } - } - }, - "parameters": { - "PrivateLinkScopeName": { - "name": "scopeName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure Arc PrivateLinkScope resource.", - "x-ms-parameter-location": "method" - }, - "PrivateLinkScopeId": { - "name": "privateLinkScopeId", - "in": "path", - "required": true, - "type": "string", - "description": "The id (Guid) of the Azure Arc PrivateLinkScope resource.", - "x-ms-parameter-location": "method" - }, - "GroupNameParameter": { - "name": "groupName", - "in": "path", - "description": "The name of the private link resource.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "LocationParameter": { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The location of the target resource.", - "minLength": 1 - }, - "MachineNameParameter": { - "name": "machineName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the target machine to get the private link scope validation details for.", - "minLength": 1, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index 21af2a70fc7b..fe5fb3b60814 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the HybridCompute API. ``` yaml openapi-type: arm -tag: package-preview-2023-04 +tag: package-preview-2023-03 directive: - where: - $.definitions.Machine.properties @@ -34,16 +34,6 @@ directive: - BodyTopLevelProperties ``` - -### Tag: package-preview-2023-04 - -These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. - -```yaml $(tag) == 'package-preview-2023-04' -input-file: - - Microsoft.HybridCompute/preview/2023-04-25-preview/HybridCompute.json - - Microsoft.HybridCompute/preview/2023-04-25-preview/privateLinkScopes.json -``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_CreateOrUpdate.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_CreateOrUpdate.json new file mode 100644 index 000000000000..625b9b057857 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "operationId": "NetworkFunctions_CreateOrUpdate", + "title": "NetworkFunctions_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1", + "resource": { + "location": "eastus", + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "userDescription": "string", + "deploymentNotes": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_Delete.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_Delete.json new file mode 100644 index 000000000000..e0978cfbabfe --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "NetworkFunctions_Delete", + "title": "NetworkFunctions_Delete", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_Get.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_Get.json new file mode 100644 index 000000000000..a3353ecacc06 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_Get.json @@ -0,0 +1,39 @@ +{ + "operationId": "NetworkFunctions_Get", + "title": "NetworkFunctions_Get", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "global", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_ListByResourceGroup.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_ListByResourceGroup.json new file mode 100644 index 000000000000..17aab31af457 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_ListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "operationId": "NetworkFunctions_ListByResourceGroup", + "title": "NetworkFunctions_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "global", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_ListBySubscription.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_ListBySubscription.json new file mode 100644 index 000000000000..2f08c3f30bbe --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "NetworkFunctions_ListBySubscription", + "title": "NetworkFunctions_ListBySubscription", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "global", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_UpdateTags.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_UpdateTags.json new file mode 100644 index 000000000000..3e6871f6f2b9 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/NetworkFunctions_UpdateTags.json @@ -0,0 +1,45 @@ +{ + "operationId": "NetworkFunctions_UpdateTags", + "title": "NetworkFunctions_UpdateTags", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/OperationList.json b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/OperationList.json new file mode 100644 index 000000000000..55325313d05e --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/examples/2023-05-15-preview/OperationList.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "OperationsList", + "parameters": { + "api-version": "2023-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MobilePacketCore/networkFunctions/read", + "display": { + "provider": "Microsoft.MobilePacketCore", + "resource": "NetworkFunction", + "operation": "read", + "description": "Read network function resources" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/main.tsp b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/main.tsp new file mode 100644 index 000000000000..1b347be5ec84 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/main.tsp @@ -0,0 +1,28 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +import "./networkfunction.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; + +@doc("Mobile Packet Core Network Function Management API") +@armProviderNamespace("Microsoft.MobilePacketCore") +@service({ + title: "Microsoft.MobilePacketCore Network Function resource", +}) +@versioned(Versions) +namespace Microsoft.MobilePacketCore; + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("API Versions") +enum Versions { + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("May 15, 2023 Preview API Version") + v2023_05_15_preview: "2023-05-15-preview", +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/networkfunction.tsp b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/networkfunction.tsp new file mode 100644 index 000000000000..ac4aa5088c20 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/networkfunction.tsp @@ -0,0 +1,211 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/openapi"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using OpenAPI; + +namespace Microsoft.MobilePacketCore; + +@doc("AO5GC Network Function Resource") +model NetworkFunctionResource + is TrackedResource { + @doc("The name of the network function") + @pattern("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") + @minLength(1) + @maxLength(63) + @key("networkFunctionName") + @path + @segment("networkFunctions") + @visibility("create", "read") + name: string; +} + +@doc("Network Function Properties.") +model NetworkFunctionResourceProperties { + @doc("Provisioned SKU Value.") + @visibility("create", "read") + sku: SkuDefinitions; + + @doc("Type of network function") + @visibility("create", "read") + networkFunctionType: NetworkFunctionType; + + @doc("Administrative state of the network function") + networkFunctionAdministrativeState: NetworkFunctionAdministrativeState; + + @doc("Operational state of the network function") + @visibility("read") + networkFunctionOperationalStatus?: NetworkFunctionOperationalStatus; + + @doc("Count of infrastructure elements used by this network function (vCPUs, in units of 8)") + @visibility("read") + infrastructureElementCount?: int32; + + @doc("Capacity of the network function in units of 10000. This represents the session count or the Simultaneously Attached Users (SAU) count as applicable") + @visibility("create", "read") + capacity?: int32; + + @doc("User provided description") + userDescription?: string; + + @doc("User provided deployment notes. This is used to optionally provide details about the NF deployment") + deploymentNotes?: string; + + @doc("The status of the last operation.") + @visibility("read") + provisioningState?: ProvisioningState; +} + +/** Compliant create or update template */ +/** + * A long-running resource CreateOrUpdate (PUT) + * @template TResource the resource being patched + * @template TBaseParameters Optional. Allows overriding the operation parameters + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-outside-interface" "This is a valid template" +@autoRoute +@doc("Create a {name}", TResource) +@OpenAPI.extension("x-ms-long-running-operation", true) +@OpenAPI.extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "azure-async-operation", + } +) +@armResourceCreateOrUpdate(TResource) +@put +op ArmResourceCreateOrUpdate2Async< + TResource extends Azure.ResourceManager.Foundations.ArmResource, + TBaseParameters = Azure.ResourceManager.Foundations.BaseParameters +>( + ...ResourceInstanceParameters, + + @doc("Resource create parameters.") + @body + resource: TResource, +): ArmUpdatedResponse | ArmCreatedResponse | ErrorResponse; + +@doc("ARM resource update successful") +model ArmUpdatedResponse + is ArmResponse; + +@armResourceOperations(NetworkFunctionResource) +interface NetworkFunctions { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrUpdate2Async; + updateTags is ArmTagsPatchSync; + delete is ArmResourceDeleteSync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} + +@doc("SKU Definitions") +enum SkuDefinitions { + @doc("Azure Lab SKU") + AzureLab, + + @doc("Azure Production SKU") + AzureProduction, + + @doc("Nexus Lab SKU") + NexusLab, + + @doc("Nexus Production SKU") + NexusProduction, +} + +@doc("Type of Network Function") +enum NetworkFunctionType { + @doc("Access and Mobility Function") + AMF, + + @doc("Session Management Function") + SMF, + + @doc("User Plane Function") + UPF, + + @doc("Network Repository Function") + NRF, + + @doc("Network Slice Selection Function") + NSSF, + + @doc("Mobility Management Entity") + MME, + + @doc("System Architecture Evolution Gateway Control Plane, control and user plane separation (CUPS) architecture") + SaegwControlPlane, + + @doc("System Architecture Evolution Gateway User Plane, control and user plane separation (CUPS) architecture") + SaegwUserPlane, + + @doc("System Architecture Evolution Gateway. This combines the Serving Gateway (SGW) and the Packet Data Network Gateway (PGW) functionality") + Saegw, + + @doc("Evolved Packet Data Gateway") + ePDG, + + @doc("Non-3GPP Interworking Function") + N3IWF, + + @doc("Remote Platform As A Service Components") + RemotePaaS, + + @doc("Element Management System") + EMS, + + @doc("Operations and Policy Manager") + OperationsPolicyManager, +} + +@doc("Network Function Administrative State enumerations") +enum NetworkFunctionAdministrativeState { + @doc("Resource has been commissioned") + Commissioned, + + @doc("Resource has been decommissioned") + Decommissioned, +} + +@doc("Network Function Operational Status enumerations") +enum NetworkFunctionOperationalStatus { + @doc("Resource is inactive") + Inactive, + + @doc("Resource has been deployed, awaiting provisioning") + InstantiatedNotProvisioned, + + @doc("Resource has been deployed and provisioned, awaiting testing") + InstantiatedProvisioned, + + @doc("Resource is fully deployed and operational") + Active, +} + +@doc("Provisioning state of the resource") +@Azure.Core.lroStatus +enum ProvisioningState { + ...ResourceProvisioningState, + + @doc("Resource is getting provisioned") + Provisioning, + + @doc("Resource is updating") + Updating, + + @doc("Resource is getting deleted") + Deleting, + + @doc("Resource has been accepted") + Accepted, +} diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/readme.txt b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/readme.txt new file mode 100644 index 000000000000..65cba162286e --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/readme.txt @@ -0,0 +1,11 @@ +- Install typespec as per instructions +https://github.com/Microsoft/typespec + +- Install providerhub controller +npm i @azure-tools/typespec-providerhub-controller + +- Initialize directory +tsp init + +- Compile typespec and generate swagger and code +tsp compile . --emit @azure-tools/typespec-autorest --emit @azure-tools/typespec-providerhub-controller diff --git a/specification/mpcnetworkfunction/mpcnetworkfunction.Management/tspconfig.yaml b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/tspconfig.yaml new file mode 100644 index 000000000000..8910415dd0b0 --- /dev/null +++ b/specification/mpcnetworkfunction/mpcnetworkfunction.Management/tspconfig.yaml @@ -0,0 +1,11 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/networkfunction.json" + "@azure-tools/typespec-providerhub-controller": + emitter-output-dir: "{output-dir}/generated" + code-kind: model diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_CreateOrUpdate.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_CreateOrUpdate.json new file mode 100644 index 000000000000..625b9b057857 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "operationId": "NetworkFunctions_CreateOrUpdate", + "title": "NetworkFunctions_CreateOrUpdate", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1", + "resource": { + "location": "eastus", + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "userDescription": "string", + "deploymentNotes": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_Delete.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_Delete.json new file mode 100644 index 000000000000..e0978cfbabfe --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "NetworkFunctions_Delete", + "title": "NetworkFunctions_Delete", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_Get.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_Get.json new file mode 100644 index 000000000000..a3353ecacc06 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_Get.json @@ -0,0 +1,39 @@ +{ + "operationId": "NetworkFunctions_Get", + "title": "NetworkFunctions_Get", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "global", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_ListByResourceGroup.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_ListByResourceGroup.json new file mode 100644 index 000000000000..17aab31af457 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_ListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "operationId": "NetworkFunctions_ListByResourceGroup", + "title": "NetworkFunctions_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "global", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_ListBySubscription.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_ListBySubscription.json new file mode 100644 index 000000000000..2f08c3f30bbe --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_ListBySubscription.json @@ -0,0 +1,41 @@ +{ + "operationId": "NetworkFunctions_ListBySubscription", + "title": "NetworkFunctions_ListBySubscription", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "global", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_UpdateTags.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_UpdateTags.json new file mode 100644 index 000000000000..3e6871f6f2b9 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/NetworkFunctions_UpdateTags.json @@ -0,0 +1,45 @@ +{ + "operationId": "NetworkFunctions_UpdateTags", + "title": "NetworkFunctions_UpdateTags", + "parameters": { + "api-version": "2023-05-15-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkFunctionName": "nf1", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobilePacketCore/networkFunctions/nf1", + "name": "nf1", + "type": "Microsoft.MobilePacketCore/networkFunctions", + "location": "eastus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-06-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-02T17:18:19.1234567Z" + }, + "properties": { + "sku": "NexusProduction", + "networkFunctionType": "SMF", + "capacity": 100000, + "networkFunctionAdministrativeState": "Commissioned", + "networkFunctionOperationalStatus": "Active", + "infrastructureElementCount": 10, + "userDescription": "string", + "deploymentNotes": "string", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/OperationList.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/OperationList.json new file mode 100644 index 000000000000..55325313d05e --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/examples/OperationList.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "OperationsList", + "parameters": { + "api-version": "2023-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MobilePacketCore/networkFunctions/read", + "display": { + "provider": "Microsoft.MobilePacketCore", + "resource": "NetworkFunction", + "operation": "read", + "description": "Read network function resources" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json new file mode 100644 index 000000000000..3848d4076139 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json @@ -0,0 +1,778 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.MobilePacketCore Network Function resource", + "version": "2023-05-15-preview", + "description": "Mobile Packet Core Network Function Management API", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "NetworkFunctions" + } + ], + "paths": { + "/providers/Microsoft.MobilePacketCore/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobilePacketCore/networkFunctions": { + "get": { + "operationId": "NetworkFunctions_ListBySubscription", + "tags": [ + "NetworkFunctions" + ], + "description": "List NetworkFunctionResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunctionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFunctions_ListBySubscription": { + "$ref": "./examples/NetworkFunctions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/networkFunctions": { + "get": { + "operationId": "NetworkFunctions_ListByResourceGroup", + "tags": [ + "NetworkFunctions" + ], + "description": "List NetworkFunctionResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunctionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFunctions_ListByResourceGroup": { + "$ref": "./examples/NetworkFunctions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobilePacketCore/networkFunctions/{networkFunctionName}": { + "get": { + "operationId": "NetworkFunctions_Get", + "tags": [ + "NetworkFunctions" + ], + "description": "Get a NetworkFunctionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "description": "The name of the network function", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunctionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFunctions_Get": { + "$ref": "./examples/NetworkFunctions_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFunctions_CreateOrUpdate", + "tags": [ + "NetworkFunctions" + ], + "description": "Create a NetworkFunctionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "description": "The name of the network function", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunctionResource" + } + } + ], + "responses": { + "200": { + "description": "ARM resource update successful", + "schema": { + "$ref": "#/definitions/NetworkFunctionResource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunctionResource" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFunctions_CreateOrUpdate": { + "$ref": "./examples/NetworkFunctions_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFunctions_UpdateTags", + "tags": [ + "NetworkFunctions" + ], + "description": "Update a NetworkFunctionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "description": "The name of the network function", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunctionResourceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunctionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFunctions_UpdateTags": { + "$ref": "./examples/NetworkFunctions_UpdateTags.json" + } + } + }, + "delete": { + "operationId": "NetworkFunctions_Delete", + "tags": [ + "NetworkFunctions" + ], + "description": "Delete a NetworkFunctionResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "description": "The name of the network function", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFunctions_Delete": { + "$ref": "./examples/NetworkFunctions_Delete.json" + } + } + } + } + }, + "definitions": { + "NetworkFunctionAdministrativeState": { + "type": "string", + "description": "Network Function Administrative State enumerations", + "enum": [ + "Commissioned", + "Decommissioned" + ], + "x-ms-enum": { + "name": "NetworkFunctionAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Commissioned", + "value": "Commissioned", + "description": "Resource has been commissioned" + }, + { + "name": "Decommissioned", + "value": "Decommissioned", + "description": "Resource has been decommissioned" + } + ] + } + }, + "NetworkFunctionOperationalStatus": { + "type": "string", + "description": "Network Function Operational Status enumerations", + "enum": [ + "Inactive", + "InstantiatedNotProvisioned", + "InstantiatedProvisioned", + "Active" + ], + "x-ms-enum": { + "name": "NetworkFunctionOperationalStatus", + "modelAsString": true, + "values": [ + { + "name": "Inactive", + "value": "Inactive", + "description": "Resource is inactive" + }, + { + "name": "InstantiatedNotProvisioned", + "value": "InstantiatedNotProvisioned", + "description": "Resource has been deployed, awaiting provisioning" + }, + { + "name": "InstantiatedProvisioned", + "value": "InstantiatedProvisioned", + "description": "Resource has been deployed and provisioned, awaiting testing" + }, + { + "name": "Active", + "value": "Active", + "description": "Resource is fully deployed and operational" + } + ] + } + }, + "NetworkFunctionResource": { + "type": "object", + "description": "AO5GC Network Function Resource", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFunctionResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFunctionResourceListResult": { + "type": "object", + "description": "The response of a NetworkFunctionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFunctionResource items on this page", + "items": { + "$ref": "#/definitions/NetworkFunctionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFunctionResourceProperties": { + "type": "object", + "description": "Network Function Properties.", + "properties": { + "sku": { + "$ref": "#/definitions/SkuDefinitions", + "description": "Provisioned SKU Value.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkFunctionType": { + "$ref": "#/definitions/NetworkFunctionType", + "description": "Type of network function", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkFunctionAdministrativeState": { + "$ref": "#/definitions/NetworkFunctionAdministrativeState", + "description": "Administrative state of the network function" + }, + "networkFunctionOperationalStatus": { + "$ref": "#/definitions/NetworkFunctionOperationalStatus", + "description": "Operational state of the network function", + "readOnly": true + }, + "infrastructureElementCount": { + "type": "integer", + "format": "int32", + "description": "Count of infrastructure elements used by this network function (vCPUs, in units of 8)", + "readOnly": true + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the network function in units of 10000. This represents the session count or the Simultaneously Attached Users (SAU) count as applicable", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "userDescription": { + "type": "string", + "description": "User provided description" + }, + "deploymentNotes": { + "type": "string", + "description": "User provided deployment notes. This is used to optionally provide details about the NF deployment" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "sku", + "networkFunctionType", + "networkFunctionAdministrativeState" + ] + }, + "NetworkFunctionResourceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkFunctionResource resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkFunctionType": { + "type": "string", + "description": "Type of Network Function", + "enum": [ + "AMF", + "SMF", + "UPF", + "NRF", + "NSSF", + "MME", + "SaegwControlPlane", + "SaegwUserPlane", + "Saegw", + "ePDG", + "N3IWF", + "RemotePaaS", + "EMS", + "OperationsPolicyManager" + ], + "x-ms-enum": { + "name": "NetworkFunctionType", + "modelAsString": true, + "values": [ + { + "name": "AMF", + "value": "AMF", + "description": "Access and Mobility Function" + }, + { + "name": "SMF", + "value": "SMF", + "description": "Session Management Function" + }, + { + "name": "UPF", + "value": "UPF", + "description": "User Plane Function" + }, + { + "name": "NRF", + "value": "NRF", + "description": "Network Repository Function" + }, + { + "name": "NSSF", + "value": "NSSF", + "description": "Network Slice Selection Function" + }, + { + "name": "MME", + "value": "MME", + "description": "Mobility Management Entity" + }, + { + "name": "SaegwControlPlane", + "value": "SaegwControlPlane", + "description": "System Architecture Evolution Gateway Control Plane, control and user plane separation (CUPS) architecture" + }, + { + "name": "SaegwUserPlane", + "value": "SaegwUserPlane", + "description": "System Architecture Evolution Gateway User Plane, control and user plane separation (CUPS) architecture" + }, + { + "name": "Saegw", + "value": "Saegw", + "description": "System Architecture Evolution Gateway. This combines the Serving Gateway (SGW) and the Packet Data Network Gateway (PGW) functionality" + }, + { + "name": "ePDG", + "value": "ePDG", + "description": "Evolved Packet Data Gateway" + }, + { + "name": "N3IWF", + "value": "N3IWF", + "description": "Non-3GPP Interworking Function" + }, + { + "name": "RemotePaaS", + "value": "RemotePaaS", + "description": "Remote Platform As A Service Components" + }, + { + "name": "EMS", + "value": "EMS", + "description": "Element Management System" + }, + { + "name": "OperationsPolicyManager", + "value": "OperationsPolicyManager", + "description": "Operations and Policy Manager" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is getting provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is getting deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource has been accepted" + } + ] + } + }, + "SkuDefinitions": { + "type": "string", + "description": "SKU Definitions", + "enum": [ + "AzureLab", + "AzureProduction", + "NexusLab", + "NexusProduction" + ], + "x-ms-enum": { + "name": "SkuDefinitions", + "modelAsString": true, + "values": [ + { + "name": "AzureLab", + "value": "AzureLab", + "description": "Azure Lab SKU" + }, + { + "name": "AzureProduction", + "value": "AzureProduction", + "description": "Azure Production SKU" + }, + { + "name": "NexusLab", + "value": "NexusLab", + "description": "Nexus Lab SKU" + }, + { + "name": "NexusProduction", + "value": "NexusProduction", + "description": "Nexus Production SKU" + } + ] + } + }, + "Versions": { + "type": "string", + "description": "API Versions", + "enum": [ + "2023-05-15-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2023_05_15_preview", + "value": "2023-05-15-preview", + "description": "May 15, 2023 Preview API Version" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/mpcnetworkfunction/resource-manager/readme.csharp.md b/specification/mpcnetworkfunction/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..145724961248 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.MobilePacketCore + output-folder: $(csharp-sdks-folder)/mobilePacketCore/management/$(namespace)/GeneratedProtocol +``` diff --git a/specification/mpcnetworkfunction/resource-manager/readme.go.md b/specification/mpcnetworkfunction/resource-manager/readme.go.md new file mode 100644 index 000000000000..42ac2dae48f3 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.go.md @@ -0,0 +1,21 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/mobilepacketcore/armmobilepacketcore +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +### Tag: package-2023-05-15-preview and go + +These settings apply only when `--tag=package-2023-05-15-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2023-05-15-preview' && $(go) +namespace: mpcnetworkfunction +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2023-05-15-preview/$(namespace) +``` diff --git a/specification/mpcnetworkfunction/resource-manager/readme.md b/specification/mpcnetworkfunction/resource-manager/readme.md new file mode 100644 index 000000000000..6afcb4af89a5 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.md @@ -0,0 +1,79 @@ +# mobileCore + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for mobileCore. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. +--- + + +## Configuration + +### Basic Information + +These are the global settings for the Mobile Packet Core Network Function service. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2023-05-15-preview +``` + +### Tag: package-2023-05-15-preview + +These settings apply only when `--tag=package-2023-05-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-05-15-preview' +input-file: + - Microsoft.MobilePacketCore/preview/2023-05-15-preview/networkfunction.json +``` + + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_mobileCore'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/mpcnetworkfunction/resource-manager/readme.python.md b/specification/mpcnetworkfunction/resource-manager/readme.python.md new file mode 100644 index 000000000000..85e1a1ae4cc7 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.MobilePacketCore + package-name: mobileCore + package-version: 2023-05-15-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/mobileCore +``` diff --git a/specification/mpcnetworkfunction/resource-manager/readme.ruby.md b/specification/mpcnetworkfunction/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..a25fd3d8beb7 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_mobileCore +package-version: 2023-05-15-preview +azure-arm: true +``` + +### Tag: package-2023-05-15-preview and ruby + +These settings apply only when `--tag=package-2023-05-15-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2023-05-15-preview' && $(ruby) +namespace: Microsoft.MobilePacketCore +output-folder: $(ruby-sdks-folder)/mobileCore +``` diff --git a/specification/mpcnetworkfunction/resource-manager/readme.typescript.md b/specification/mpcnetworkfunction/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..23f54761aed7 --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-mobilecore" + output-folder: "$(typescript-sdks-folder)/sdk/mobilecore/arm-mobilecore" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorDelete.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorDelete.json index 17aa5b3c1fe8..04e9dbf66087 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorDelete.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorDelete.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorGet.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorGet.json index 6926aa24652f..e4f92d19f5cf 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorGet.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorGet.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc" - }, - "responses": { - "200": { - "body": { - "name": "atc", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors", - "location": "West US", - "tags": { - "key1": "value1" - }, - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "properties": { - "collectorPolicies": [], - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc" + }, + "responses": { + "200": { + "body": { + "name": "atc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors", + "location": "West US", + "tags": { + "key1": "value1" + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "collectorPolicies": [], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorUpdateTags.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorUpdateTags.json index d261d24f1a80..ba9486c28c42 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorUpdateTags.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorUpdateTags.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc", - "parameters": { - "tags": { - "key1": "value1", - "key2": "value2" - } - } - }, - "responses": { - "200": { - "body": { - "name": "atc", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "collectorPolicies": [], - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "atc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "collectorPolicies": [], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsByResourceGroupList.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsByResourceGroupList.json index bed12f0b8660..d6742c067aa1 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsByResourceGroupList.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsByResourceGroupList.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "atc", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "tags": { - "key1": "value1" - }, - "properties": { - "collectorPolicies": [], - "provisioningState": "Succeeded" - } - } - ], - "nextLink": "string" - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "atc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "collectorPolicies": [], + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsBySubscriptionList.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsBySubscriptionList.json index f9aa8d306087..52a7af11f439 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsBySubscriptionList.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/AzureTrafficCollectorsBySubscriptionList.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "atc", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors", - "etag": "w/\\00000000-0000-0000-0000-000000000000\\", - "location": "West US", - "tags": { - "key1": "value1" - }, - "properties": { - "collectorPolicies": [], - "provisioningState": "Succeeded" - } - } - ], - "nextLink": "string" - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "atc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "collectorPolicies": [], + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPoliciesList.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPoliciesList.json index a64f9db3c081..3f12a63b7f8c 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPoliciesList.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPoliciesList.json @@ -1,44 +1,44 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "atc", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1", - "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", - "properties": { - "ingestionPolicy": { - "ingestionType": "IPFIX", - "ingestionSources": [ - { - "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", - "sourceType": "Resource" - } - ] - }, - "emissionPolicies": [ - { - "emissionType": "IPFIX", - "emissionDestinations": [ - { - "destinationType": "AzureMonitor" - } - ] - } - ], - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "atc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1", + "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", + "properties": { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyCreate.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyCreate.json index 045387db62a2..569c59d95a5c 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyCreate.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyCreate.json @@ -1,95 +1,95 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc", - "collectorPolicyName": "cp1", - "parameters": { - "location": "West US", - "properties": { - "ingestionPolicy": { - "ingestionType": "IPFIX", - "ingestionSources": [ - { - "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", - "sourceType": "Resource" - } - ] - }, - "emissionPolicies": [ - { - "emissionType": "IPFIX", - "emissionDestinations": [ - { - "destinationType": "AzureMonitor" - } - ] - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "name": "cp1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/AzureTrafficCollector/atc/collectorPolicies/cp1", - "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", - "properties": { - "ingestionPolicy": { - "ingestionType": "IPFIX", - "ingestionSources": [ - { - "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", - "sourceType": "Resource" - } - ] - }, - "emissionPolicies": [ - { - "emissionType": "IPFIX", - "emissionDestinations": [ - { - "destinationType": "AzureMonitor" - } - ] - } - ], - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "name": "cp1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1", - "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", - "properties": { - "ingestionPolicy": { - "ingestionType": "IPFIX", - "ingestionSources": [ - { - "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", - "sourceType": "Resource" - } - ] - }, - "emissionPolicies": [ - { - "emissionType": "IPFIX", - "emissionDestinations": [ - { - "destinationType": "AzureMonitor" - } - ] - } - ], - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc", + "collectorPolicyName": "cp1", + "parameters": { + "location": "West US", + "properties": { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/AzureTrafficCollector/atc/collectorPolicies/cp1", + "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", + "properties": { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "cp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1", + "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", + "properties": { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyDelete.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyDelete.json index f870f59d95f7..cc99ba2eec29 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyDelete.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc", - "collectorPolicyName": "cp1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc", + "collectorPolicyName": "cp1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyGet.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyGet.json index 14ea006a7925..226ff692ffca 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyGet.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/CollectorPolicyGet.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "api-version": "2022-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "azureTrafficCollectorName": "atc", - "collectorPolicyName": "cp1" - }, - "responses": { - "200": { - "body": { - "name": "atc", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1", - "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", - "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", - "properties": { - "ingestionPolicy": { - "ingestionType": "IPFIX", - "ingestionSources": [ - { - "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", - "sourceType": "Resource" - } - ] - }, - "emissionPolicies": [ - { - "emissionType": "IPFIX", - "emissionDestinations": [ - { - "destinationType": "AzureMonitor" - } - ] - } - ], - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureTrafficCollectorName": "atc", + "collectorPolicyName": "cp1" + }, + "responses": { + "200": { + "body": { + "name": "atc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.NetworkFunction/azureTrafficCollectors/atc/collectorPolicies/cp1", + "etag": "w/\\72090554-7e3b-43f2-80ad-99a9020dcb11\\", + "type": "Microsoft.NetworkFunction/azureTrafficCollectors/collectorPolicies", + "properties": { + "ingestionPolicy": { + "ingestionType": "IPFIX", + "ingestionSources": [ + { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "sourceType": "Resource" + } + ] + }, + "emissionPolicies": [ + { + "emissionType": "IPFIX", + "emissionDestinations": [ + { + "destinationType": "AzureMonitor" + } + ] + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/OperationsList.json b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/OperationsList.json index 1f34c687cae8..0b5b39a8dc26 100644 --- a/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/OperationsList.json +++ b/specification/networkfunction/resource-manager/Microsoft.NetworkFunction/stable/2022-08-01/examples/OperationsList.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "api-version": "2022-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.NetworkFunction/azureTrafficCollectors/write", - "display": { - "provider": "Microsoft NetworkFunction", - "resource": "AzureTrafficCollector", - "operation": "Create/Update a azure traffic collector", - "description": "Creates or Update a azure traffic collector" - } - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetworkFunction/azureTrafficCollectors/write", + "display": { + "provider": "Microsoft NetworkFunction", + "resource": "AzureTrafficCollector", + "operation": "Create/Update a azure traffic collector", + "description": "Creates or Update a azure traffic collector" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/readme.go.md b/specification/resources/resource-manager/readme.go.md index 42ba1bdeee0d..4deab0fda551 100644 --- a/specification/resources/resource-manager/readme.go.md +++ b/specification/resources/resource-manager/readme.go.md @@ -100,6 +100,14 @@ output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true ``` +``` yaml $(go) && $(track2) && $(package-deploymentstacks) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/resources/armdeploymentstacks +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + ### Go multi-api ``` yaml $(go) && $(multiapi) diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 2085fe72bace..f8f3455b8e46 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -907,7 +907,8 @@ These settings apply only when `--tag=package-2023-05` is specified on the comma ```yaml $(tag) == 'package-2023-05' input-file: - - Microsoft.Security/stable/2023-05-01/serverVulnerabilityAssessmentsSettings.json + - Microsoft.Security/stable/2023-05-01/ServerVulnerabilityAssessmentsSettings.json +``` --- diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json index f094382d1f46..d84cb3fef21b 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json @@ -252,13 +252,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'TrafficController' update operation succeeded", "schema": { "$ref": "#/definitions/TrafficController" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'TrafficController' create operation succeeded", "schema": { "$ref": "#/definitions/TrafficController" }, @@ -553,13 +553,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Association' update operation succeeded", "schema": { "$ref": "#/definitions/Association" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Association' create operation succeeded", "schema": { "$ref": "#/definitions/Association" }, @@ -870,13 +870,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Frontend' update operation succeeded", "schema": { "$ref": "#/definitions/Frontend" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Frontend' create operation succeeded", "schema": { "$ref": "#/definitions/Frontend" }, diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json index 9a3713ef8493..216a568ba9a5 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json @@ -264,13 +264,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Catalog' update operation succeeded", "schema": { "$ref": "#/definitions/Catalog" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Catalog' create operation succeeded", "schema": { "$ref": "#/definitions/Catalog" }, @@ -855,13 +855,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Image' update operation succeeded", "schema": { "$ref": "#/definitions/Image" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Image' create operation succeeded", "schema": { "$ref": "#/definitions/Image" }, @@ -1366,13 +1366,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Product' update operation succeeded", "schema": { "$ref": "#/definitions/Product" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Product' create operation succeeded", "schema": { "$ref": "#/definitions/Product" }, @@ -1792,13 +1792,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'DeviceGroup' update operation succeeded", "schema": { "$ref": "#/definitions/DeviceGroup" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'DeviceGroup' create operation succeeded", "schema": { "$ref": "#/definitions/DeviceGroup" }, @@ -2344,13 +2344,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Deployment' update operation succeeded", "schema": { "$ref": "#/definitions/Deployment" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Deployment' create operation succeeded", "schema": { "$ref": "#/definitions/Deployment" }, @@ -2662,13 +2662,13 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'Device' update operation succeeded", "schema": { "$ref": "#/definitions/Device" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'Device' create operation succeeded", "schema": { "$ref": "#/definitions/Device" }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Cancel.json index 54f5e55cb817..37e7ce18aec8 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Cancel.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Cancel.json @@ -18,7 +18,7 @@ "result": { "runId": "4b200abf-c90c-43cf-98ae-b9f2bcf90373", "runStatus": "Cancelled", - "sessionId": -1, + "sessionId": "-1", "sparkPool": "exampleSparkpool", "lastCheckedOn": "0001-01-01T00:00:00" } @@ -37,7 +37,7 @@ "result": { "runId": "4b200abf-c90c-43cf-98ae-b9f2bcf90373", "runStatus": "SnapshotTaken", - "sessionId": -1, + "sessionId": "-1", "sparkPool": "exampleSparkpool" } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Create.json index 0e726f89dbad..c4c1837e6702 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_Create.json @@ -39,7 +39,7 @@ "result": { "runId": "4b200abf-c90c-43cf-98ae-b9f2bcf90373", "runStatus": "Starting", - "sessionId": -1, + "sessionId": "-1", "sparkPool": "exampleSparkpool", "lastCheckedOn": "0001-01-01T00:00:00" } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetSnapshot.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetSnapshot.json index 1a29f7504318..1046e5b665d1 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetSnapshot.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetSnapshot.json @@ -232,7 +232,7 @@ }, "runId": "e4221395-55ae-4c6d-9756-fae966d84350", "runStatus": "Succeeded", - "sessionId": 1, + "sessionId": "1", "sparkPool": "exampleSparkpool", "lastCheckedOn": "0001-01-01T00:00:00" } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetStatus.json index c9c6b451ad20..e39ee653b03a 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetStatus.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/examples/RunNotebook_GetStatus.json @@ -82,7 +82,7 @@ "exitValue": null, "runId": "4b200abf-c90c-43cf-98ae-b9f2bcf90373", "runStatus": "Starting", - "sessionId": 2, + "sessionId": "2", "sparkPool": "exampleSparkpool", "lastCheckedOn": "2021-09-06T11:23:58.3733333" } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json index 54522f9bce63..4cd70db4b317 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2022-03-01-preview/runNotebook.json @@ -242,8 +242,7 @@ }, "sessionId": { "description": "Livy session id.", - "type": "integer", - "format": "int64" + "type": "string" }, "sparkPool": { "description": "SparkPool name.", @@ -331,8 +330,7 @@ }, "sessionId": { "description": "Livy session id.", - "type": "integer", - "format": "int64" + "type": "string" }, "sparkPool": { "description": "SparkPool name.", @@ -378,8 +376,7 @@ }, "sessionId": { "description": "Livy session id.", - "type": "integer", - "format": "int64" + "type": "string" }, "sparkPool": { "description": "SparkPool name.", diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddConnectionToGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddConnectionToGroup.json index fab5a7c09489..57ac54084607 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddConnectionToGroup.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddConnectionToGroup.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1", - "connectionId": "connection1" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1", + "connectionId": "connection1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddUserToGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddUserToGroup.json index 8a2e03f7bb47..a3804fb01563 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddUserToGroup.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_AddUserToGroup.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1", - "userId": "user1" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1", + "userId": "user1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CheckPermission.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CheckPermission.json index 3a64b92b833a..ed6bfa9bc05b 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CheckPermission.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CheckPermission.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "permission": "joinLeaveGroup", - "connectionId": "connection1", - "targetName": "group1" - }, - "responses": { - "200": {}, - "404": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "permission": "joinLeaveGroup", + "connectionId": "connection1", + "targetName": "group1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseAllConnections.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseAllConnections.json index 0b2aa8f4ec5b..3be7f3b4d403 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseAllConnections.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseAllConnections.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "reason": "Close reason" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseConnection.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseConnection.json index fc4a12897478..3bc27a0c81b2 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseConnection.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseConnection.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "connectionId": "connection1", - "reason": "Close reason" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "connectionId": "connection1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseGroupConnections.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseGroupConnections.json index f617479d7074..d74842f94d3f 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseGroupConnections.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseGroupConnections.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1", - "reason": "Close reason" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseUserConnections.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseUserConnections.json index 35efffd56840..fce57034ea9d 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseUserConnections.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_CloseUserConnections.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "userId": "user1", - "reason": "Close reason" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "userId": "user1", + "reason": "Close reason" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_ConnectionExists.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_ConnectionExists.json index 1de67bfbe343..ec373d36c49a 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_ConnectionExists.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_ConnectionExists.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "connectionId": "connection1" - }, - "responses": { - "200": {}, - "404": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "connectionId": "connection1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GenerateClientToken.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GenerateClientToken.json index f0bed1a3c14b..dba171a50b87 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GenerateClientToken.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GenerateClientToken.json @@ -1,15 +1,15 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "userId": "user1", - "minutesToExpire": 5 - }, - "responses": { - "200": { - "body": { - "token": "ABC" - } - } - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "userId": "user1", + "minutesToExpire": 5 + }, + "responses": { + "200": { + "body": { + "token": "ABC" + } + } + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GrantPermission.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GrantPermission.json index fe7299abb560..977af60d1031 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GrantPermission.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GrantPermission.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "permission": "joinLeaveGroup", - "connectionId": "connection1", - "targetName": "group1" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "permission": "joinLeaveGroup", + "connectionId": "connection1", + "targetName": "group1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GroupExists.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GroupExists.json index 413f5d1124d8..e1ca94bfc88b 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GroupExists.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_GroupExists.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1" - }, - "responses": { - "200": {}, - "404": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveConnectionFromGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveConnectionFromGroup.json index 33e793772ed4..555f52446b39 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveConnectionFromGroup.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveConnectionFromGroup.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1", - "connectionId": "connection1" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1", + "connectionId": "connection1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromAllGroups.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromAllGroups.json index 56b127090c51..2042d4ca9c9c 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromAllGroups.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromAllGroups.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "userId": "user1" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "userId": "user1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromGroup.json index 9ae74aa90747..0b00d0b672cf 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromGroup.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RemoveUserFromGroup.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1", - "userId": "user1" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1", + "userId": "user1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RevokePermission.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RevokePermission.json index 052c290ade36..b248ff871ce6 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RevokePermission.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_RevokePermission.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "permission": "joinLeaveGroup", - "connectionId": "connection1", - "targetName": "group1" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "permission": "joinLeaveGroup", + "connectionId": "connection1", + "targetName": "group1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToAll.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToAll.json index 27fb46ed15d4..3fb2ecee5a36 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToAll.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToAll.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "message": "Message to send" - }, - "responses": { - "202": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToConnection.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToConnection.json index d9845618ee17..0230dbe61ee2 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToConnection.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToConnection.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "connectionId": "connection1", - "message": "Message to send" - }, - "responses": { - "202": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "connectionId": "connection1", + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToGroup.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToGroup.json index 63aef0c685c3..1b4f7110c9a5 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToGroup.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToGroup.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "group": "group1", - "message": "Message to send" - }, - "responses": { - "202": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "group": "group1", + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToUser.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToUser.json index ab1cbb51f0ee..bdfe492d98d8 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToUser.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_SendToUser.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "userId": "user1", - "message": "Message to send" - }, - "responses": { - "202": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "userId": "user1", + "message": "Message to send" + }, + "responses": { + "202": {} + } +} diff --git a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_UserExists.json b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_UserExists.json index c2fdab12a636..207736becf7e 100644 --- a/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_UserExists.json +++ b/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/examples/WebPubSub_UserExists.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2021-10-01", - "hub": "hub1", - "userId": "user1" - }, - "responses": { - "200": {}, - "404": {} - } -} +{ + "parameters": { + "api-version": "2021-10-01", + "hub": "hub1", + "userId": "user1" + }, + "responses": { + "200": {}, + "404": {} + } +}