openapi-directory/api/azure.com/azsadmin-FileContainer.json

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

{"openapi":"3.0.0","info":{"description":"Deployment Admin Client.","title":"DeploymentAdminClient","version":"2019-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/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-FileContainer","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/fileContainers":{"get":{"description":"Returns an array of file containers.","operationId":"FileContainers_List","parameters":[{"description":"Subscription credentials that 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"},"examples":{"Return file containers list.":{"value":"be8b2e19-7f92-4644-b808-a18283aebb01"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Return file containers list.":{"value":"2019-01-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileContainersList"},"examples":{"Return file containers list.":{"$ref":"#/components/examples/Return_file_containers_list."}}}}}},"tags":["FileContainers"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/{fileContainerId}":{"delete":{"description":"Delete an existing file container.","operationId":"FileContainers_Delete","parameters":[{"description":"Subscription credentials that 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"},"examples":{"Deletes specified file container.":{"value":"be8b2e19-7f92-4644-b808-a18283aebb01"}}},{"$ref":"#/components/parameters/FileContainerIdParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Deletes specified file container.":{"value":"2019-01-01"}}}],"responses":{"200":{"description":"OK"},"404":{"description":"Not found"}},"summary":"Deletes specified file container.","tags":["FileContainers"]},"get":{"description":"Retrieves the specific file container details.","operationId":"FileContainers_Get","parameters":[{"description":"Subscription credentials that 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"},"examples":{"Return the file container details.":{"value":"be8b2e19-7f92-4644-b808-a18283aebb01"}}},{"$ref":"#/components/parameters/FileContainerIdParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Return the file container details.":{"value":"2019-01-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileContainer"},"examples":{"Return the file container details.":{"$ref":"#/components/examples/Return_the_file_container_details."}}}}},"404":{"description":"Not Found"}},"tags":["FileContainers"]},"put":{"description":"Creates a new file container.","operationId":"FileContainers_Create","parameters":[{"description":"Subscription credentials that 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"},"examples":{"Creates a new file container.":{"value":"be8b2e19-7f92-4644-b808-a18283aebb01"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Creates a new file container.":{"value":"2019-01-01"}}},{"$ref":"#/components/parameters/FileContainerIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileContainerParameters"}}},"description":"The parameters required to create a new file container.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileContainer"},"examples":{"Creates a new file container.":{"$ref":"#/components/examples/Creates_a_new_file_container."}}}}},"202":{"description":"Accepted"}},"tags":["FileContainers"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Return_file_containers_list.":{"value":{"value":[{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/Microsoft.NullProvider.1.1","location":"global","name":"global/Microsoft.NullProvider.1.1","properties":{"postCopyAction":"Unzip","provisioningState":"Succeeded","uri":"https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/"},"type":"Microsoft.Deployment.Admin/locations/fileContainers"}]}},"Return_the_file_container_details.":{"value":{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/Microsoft.NullProvider.1.1","location":"global","name":"global/Microsoft.NullProvider.1.1","properties":{"postCopyAction":"Unzip","provisioningState":"Succeeded","uri":"https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/"},"type":"Microsoft.Deployment.Admin/locations/fileContainers"}},"Creates_a_new_file_container.":{"value":{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/fileContainers/Microsoft.NullProvider.1.1","location":"global","name":"global/Microsoft.NullProvider.1.1","properties":{"postCopyAction":"Unzip","provisioningState":"Creating"},"type":"Microsoft.Deployment.Admin/locations/fileContainers"}}},"parameters":{"FileContainerIdParameter":{"description":"The file container identifier.","in":"path","name":"fileContainerId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Deletes specified file container.":{"value":"Microsoft.NullProvider.1.1"},"Return the file container details.":{"value":"Microsoft.NullProvider.1.1"},"Creates a new file container.":{"value":"Microsoft.NullProvider.1.1"}}}},"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":{"ErrorInfo":{"description":"Extended Error Information.","properties":{"code":{"description":"The error code.","type":"string"},"details":{"description":"The detailed error messages.","items":{"$ref":"#/components/schemas/ErrorInfo"},"type":"array"},"message":{"description":"The error message.","type":"string"}},"type":"object"},"FileContainer":{"allOf":[{"description":"Object model of azure resource manager base.","properties":{"id":{"description":"ID of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"type":{"description":"Type of Resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"File container entity.","properties":{"properties":{"$ref":"#/components/schemas/FileContainerAdminProperties"}},"type":"object"},"FileContainerAdminProperties":{"description":"File Container Properties.","properties":{"error":{"$ref":"#/components/schemas/ErrorInfo"},"fileContainerId":{"$ref":"#/components/schemas/FileContainerId"},"postCopyAction":{"$ref":"#/components/schemas/PostCopyAction"},"provisioningState":{"description":"Provisioning state of the resource.","type":"string"},"sourceUri":{"$ref":"#/components/schemas/SourceUri"},"uri":{"description":"The file or container Uri. This is read-only property; a user cannot set it.","type":"string"}},"type":"object"},"FileContainerId":{"description":"File container resource identifier containing product manifest.","type":"string"},"FileContainerParameters":{"description":"Parameters for creating a new file container.","properties":{"postCopyAction":{"$ref":"#/components/schemas/PostCopyAction"},"sourceUri":{"$ref":"#/components/schemas/SourceUri"}},"type":"object"},"FileContainersList":{"description":"List of file containers.","properties":{"nextLink":{"description":"Continuation token.","type":"string"},"value":{"description":"List of file containers.","items":{"$ref":"#/components/schemas/FileContainer"},"type":"array"}}},"PostCopyAction":{"description":"Specifies the file post copy action.","enum":["None","Unzip"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PostCopyAction"}},"SourceUri":{"description":"Specifies The remote file location.","type":"string"}}}}