UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 17.3 kB
{"openapi":"3.0.0","info":{"description":"AzureBridge Admin Client.","title":"AzureBridgeAdminClient","version":"2016-01-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-AzureBridge","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.AzureBridge.Admin/operations":{"get":{"description":"Returns the list of support REST operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationList"},"examples":{"Returns the list of support REST operations.":{"$ref":"#/components/examples/Returns_the_list_of_support_REST_operations."}}}}}},"tags":["AzureBridge"],"x-ms-pageable":{"nextLinkName":"nextLink"}}}},"servers":[{"url":"https://adminmanagement.local.azurestack.external"}],"components":{"examples":{"Returns_the_list_of_support_REST_operations.":{"value":{"value":[]}}},"parameters":{"ActivationNameParameter":{"description":"Name of the activation.","in":"path","name":"activationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-01-01"},"examples":{"Returns the list of support REST operations.":{"value":"2016-05-01"}}},"ProductNameParameter":{"description":"Name of the product.","in":"path","name":"productName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"RegistrationNameParameter":{"description":"Name of the registration.","in":"path","name":"registrationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"The resource group the resource is located under.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}},"securitySchemes":{"azure_auth":{"description":"Authorization uses an Azure Active Directory OAuth2 flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Compatibility":{"description":"Product compatibility","properties":{"description":{"description":"Full error message if any compatibility issues are found","type":"string"},"isCompatible":{"description":"Tells if product is compatible with current device","type":"boolean"},"issues":{"description":"List of all issues found","items":{"description":"Compatibility issue","enum":["HigherDeviceVersionRequired","LowerDeviceVersionRequired","CapacityBillingModelRequired","PayAsYouGoBillingModelRequired","DevelopmentBillingModelRequired","AzureADIdentitySystemRequired","ADFSIdentitySystemRequired","ConnectionToInternetRequired","ConnectionToAzureRequired","DisconnectedEnvironmentRequired"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"CompatibilityIssue"}},"type":"array"},"message":{"description":"Short error message if any compatibility issues are found","type":"string"}},"type":"object"},"CompatibilityIssue":{"description":"Compatibility issue","enum":["HigherDeviceVersionRequired","LowerDeviceVersionRequired","CapacityBillingModelRequired","PayAsYouGoBillingModelRequired","DevelopmentBillingModelRequired","AzureADIdentitySystemRequired","ADFSIdentitySystemRequired","ConnectionToInternetRequired","ConnectionToAzureRequired","DisconnectedEnvironmentRequired"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"CompatibilityIssue"}},"ComputeRole":{"description":"Compute role type (IaaS or PaaS).","enum":["None","IaaS","PaaS"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ComputeRole"}},"DataDiskImage":{"description":"Data disk image.","properties":{"lun":{"description":"The LUN.","format":"int32","readOnly":true,"type":"integer"},"sourceBlobSasUri":{"description":"SAS key for source blob.","readOnly":true,"type":"string"}},"type":"object"},"Display":{"description":"Contains the localized display information for this particular operation / action.","properties":{"description":{"description":"The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.","readOnly":true,"type":"string"},"operation":{"description":"The localized, friendly name for the operation. Use the name as it will displayed to the user.","readOnly":true,"type":"string"},"provider":{"description":"The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"","readOnly":true,"type":"string"},"resource":{"description":"The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.","readOnly":true,"type":"string"}}},"DownloadedProduct":{"allOf":[{"description":"Base object for all product classes.","properties":{"billingPartNumber":{"description":"Billing part number.","type":"string"},"compatibility":{"description":"Product compatibility","properties":{"description":{"description":"Full error message if any compatibility issues are found","type":"string"},"isCompatible":{"description":"Tells if product is compatible with current device","type":"boolean"},"issues":{"description":"List of all issues found","items":{"description":"Compatibility issue","enum":["HigherDeviceVersionRequired","LowerDeviceVersionRequired","CapacityBillingModelRequired","PayAsYouGoBillingModelRequired","DevelopmentBillingModelRequired","AzureADIdentitySystemRequired","ADFSIdentitySystemRequired","ConnectionToInternetRequired","ConnectionToAzureRequired","DisconnectedEnvironmentRequired"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"CompatibilityIssue"}},"type":"array"},"message":{"description":"Short error message if any compatibility issues are found","type":"string"}},"type":"object"},"description":{"description":"Description of the product.","type":"string"},"displayName":{"description":"Name displayed for the product.","type":"string"},"galleryItemIdentity":{"description":"Gallery item identity.","type":"string"},"iconUris":{"description":"Icons for the gallery items.","properties":{"hero":{"description":"The hero (815x290) icon relative path.","type":"string"},"large":{"description":"The large (115x115) icon relative path.","type":"string"},"medium":{"description":"The medium (90x90) icon relative path.","type":"string"},"small":{"description":"The small (40x40) icon relative path.","type":"string"},"wide":{"description":"The wide (255x115) icon relative path.","type":"string"}},"type":"object"},"offer":{"description":"Offer name.","type":"string"},"offerVersion":{"description":"Offer version.","type":"string"},"payloadLength":{"description":"Size in bytes.","format":"int64","type":"integer"},"productKind":{"description":"The kind. E.g. VirtualMachineProductProperties.ProductKind or WebApp, SolutionTemplate.","type":"string"},"productProperties":{"description":"Additional properties of the product","properties":{"version":{"description":"The version of the product","type":"string"}},"type":"object"},"publisherDisplayName":{"description":"Name of publisher.","type":"string"},"publisherIdentifier":{"description":"Publisher identifier.","type":"string"},"sku":{"description":"Product SKU.","type":"string"}},"type":"object"}],"description":"Properties for aggregate usage.","properties":{"galleryPackageBlobSasUri":{"description":"The URI to the .azpkg file that provides information required for showing product in the gallery.","readOnly":true,"type":"string"},"legalTerms":{"description":"Legal terms for the product.","type":"string"},"links":{"description":"List of product links.","items":{"description":"Link to a product.","properties":{"displayName":{"description":"Displayed name of product.","type":"string"},"uri":{"description":"URI to product.","type":"string"}},"type":"object"},"type":"array"},"privacyPolicy":{"description":"Privacy policy of the product.","type":"string"},"productDetailsProperties":{"$ref":"#/components/schemas/ExtendedProductProperties"},"provisioningState":{"description":"The provisioning state of the resource.","enum":["Stopped","Starting","Running","Stopping","Succeeded","Downloading"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"vmExtensionType":{"description":"Extension type of the VM.","type":"string"}},"type":"object"},"DownloadedProductResource":{"allOf":[{"description":"Base Resource Object","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource","readOnly":true,"type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key value pairs.","readOnly":true,"type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Downloaded product resource.","properties":{"properties":{"$ref":"#/components/schemas/DownloadedProduct"}},"type":"object"},"ExtendedProductProperties":{"allOf":[{"$ref":"#/components/schemas/VirtualMachineExtensionProductProperties"},{"$ref":"#/components/schemas/VirtualMachineProductProperties"}],"description":"Product information.","properties":{},"type":"object"},"GalleryIcons":{"description":"Icons for the gallery items.","properties":{"hero":{"description":"The hero (815x290) icon relative path.","type":"string"},"large":{"description":"The large (115x115) icon relative path.","type":"string"},"medium":{"description":"The medium (90x90) icon relative path.","type":"string"},"small":{"description":"The small (40x40) icon relative path.","type":"string"},"wide":{"description":"The wide (255x115) icon relative path.","type":"string"}},"type":"object"},"OperatingSystem":{"description":"Operating system type (Windows or Linux).","enum":["None","Windows","Linux"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"OperatingSystem"}},"Operation":{"description":"Describes the supported REST operation.","properties":{"display":{"$ref":"#/components/schemas/Display"},"name":{"description":"The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.","readOnly":true,"type":"string"}}},"OperationList":{"description":"List of Operations","properties":{"nextLink":{"description":"URI to the next page of operations.","readOnly":true,"type":"string"},"value":{"description":"Array of operations","items":{"$ref":"#/components/schemas/Operation"},"readOnly":true,"type":"array"}}},"OsDiskImage":{"description":"OS disk image.","properties":{"operatingSystem":{"$ref":"#/components/schemas/OperatingSystem"},"sourceBlobSasUri":{"description":"SAS key for source blob.","readOnly":true,"type":"string"}},"type":"object"},"ProductBase":{"description":"Base object for all product classes.","properties":{"billingPartNumber":{"description":"Billing part number.","type":"string"},"compatibility":{"description":"Product compatibility","properties":{"description":{"description":"Full error message if any compatibility issues are found","type":"string"},"isCompatible":{"description":"Tells if product is compatible with current device","type":"boolean"},"issues":{"description":"List of all issues found","items":{"description":"Compatibility issue","enum":["HigherDeviceVersionRequired","LowerDeviceVersionRequired","CapacityBillingModelRequired","PayAsYouGoBillingModelRequired","DevelopmentBillingModelRequired","AzureADIdentitySystemRequired","ADFSIdentitySystemRequired","ConnectionToInternetRequired","ConnectionToAzureRequired","DisconnectedEnvironmentRequired"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"CompatibilityIssue"}},"type":"array"},"message":{"description":"Short error message if any compatibility issues are found","type":"string"}},"type":"object"},"description":{"description":"Description of the product.","type":"string"},"displayName":{"description":"Name displayed for the product.","type":"string"},"galleryItemIdentity":{"description":"Gallery item identity.","type":"string"},"iconUris":{"description":"Icons for the gallery items.","properties":{"hero":{"description":"The hero (815x290) icon relative path.","type":"string"},"large":{"description":"The large (115x115) icon relative path.","type":"string"},"medium":{"description":"The medium (90x90) icon relative path.","type":"string"},"small":{"description":"The small (40x40) icon relative path.","type":"string"},"wide":{"description":"The wide (255x115) icon relative path.","type":"string"}},"type":"object"},"offer":{"description":"Offer name.","type":"string"},"offerVersion":{"description":"Offer version.","type":"string"},"payloadLength":{"description":"Size in bytes.","format":"int64","type":"integer"},"productKind":{"description":"The kind. E.g. VirtualMachineProductProperties.ProductKind or WebApp, SolutionTemplate.","type":"string"},"productProperties":{"description":"Additional properties of the product","properties":{"version":{"description":"The version of the product","type":"string"}},"type":"object"},"publisherDisplayName":{"description":"Name of publisher.","type":"string"},"publisherIdentifier":{"description":"Publisher identifier.","type":"string"},"sku":{"description":"Product SKU.","type":"string"}},"type":"object"},"ProductLink":{"description":"Link to a product.","properties":{"displayName":{"description":"Displayed name of product.","type":"string"},"uri":{"description":"URI to product.","type":"string"}},"type":"object"},"ProductLinks":{"description":"List of product links.","items":{"description":"Link to a product.","properties":{"displayName":{"description":"Displayed name of product.","type":"string"},"uri":{"description":"URI to product.","type":"string"}},"type":"object"},"type":"array"},"ProductProperties":{"description":"Additional properties of the product","properties":{"version":{"description":"The version of the product","type":"string"}},"type":"object"},"ProvisioningState":{"description":"The provisioning state of the resource.","enum":["Stopped","Starting","Running","Stopping","Succeeded","Downloading"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"Resource":{"description":"Base Resource Object","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource","readOnly":true,"type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key value pairs.","readOnly":true,"type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"Uri":{"description":"The URI.","properties":{"uri":{"description":"The URI.","readOnly":true,"type":"string"}},"type":"object"},"VirtualMachineExtensionProductProperties":{"description":"Product information.","properties":{"computeRole":{"$ref":"#/components/schemas/ComputeRole"},"isSystemExtension":{"description":"Specifies if product is a Virtual Machine Extension.","readOnly":true,"type":"boolean"},"sourceBlob":{"$ref":"#/components/schemas/Uri"},"supportMultipleExtensions":{"description":"Indicates if specified product supports multiple extensions.","readOnly":true,"type":"boolean"},"version":{"description":"Specifies product version.","readOnly":true,"type":"string"},"vmOsType":{"$ref":"#/components/schemas/OperatingSystem"},"vmScaleSetEnabled":{"description":"Indicates if virtual machine Scale Set is enabled in the specified product.","readOnly":true,"type":"boolean"}},"type":"object"},"VirtualMachineProductProperties":{"description":"Product information.","properties":{"dataDiskImages":{"description":"List of attached data disks.","items":{"$ref":"#/components/schemas/DataDiskImage"},"readOnly":true,"type":"array"},"osDiskImage":{"$ref":"#/components/schemas/OsDiskImage"},"version":{"description":"Specifies product version.","readOnly":true,"type":"string"}},"type":"object"}}}}