openapi-directory/api/azure.com/mixedreality.json

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

{"openapi":"3.0.0","info":{"description":"Mixed Reality Resource Provider REST API","title":"Mixed Reality","version":"2019-02-28-preview","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/mixedreality/resource-manager/Microsoft.MixedReality/preview/2019-02-28-preview/mixedreality.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"mixedreality","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.MixedReality/operations":{"get":{"description":"Exposing Available Operations","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationList"},"examples":{"OperationList":{"$ref":"#/components/examples/OperationList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Proxy"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/locations/{location}/checkNameAvailability":{"post":{"description":"Check Name Availability for global uniqueness","operationId":"CheckNameAvailabilityLocal","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/locationParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityRequest"}}},"description":"Check Name Availability Request.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityResponse"},"examples":{"CheckLocalNameAvailability":{"$ref":"#/components/examples/CheckLocalNameAvailability"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Proxy"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/spatialAnchorsAccounts":{"get":{"description":"List Spatial Anchors Accounts by Subscription","operationId":"SpatialAnchorsAccounts_ListBySubscription","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccountList"},"examples":{"SpatialAnchorsAccountListBySubscription":{"$ref":"#/components/examples/SpatialAnchorsAccountListBySubscription"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Resource","Proxy"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts":{"get":{"description":"List Resources by Resource Group","operationId":"SpatialAnchorsAccounts_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccountList"},"examples":{"ResourceGet":{"$ref":"#/components/examples/ResourceGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Resource"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}":{"delete":{"description":"Delete a Spatial Anchors Account.","operationId":"SpatialAnchorsAccounts_Delete","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/spatialAnchorsAccountNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK"},"204":{"description":"NoContent"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Resource"]},"get":{"description":"Retrieve a Spatial Anchors Account.","operationId":"SpatialAnchorsAccounts_Get","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/spatialAnchorsAccountNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccount"},"examples":{"ResourceGet":{"$ref":"#/components/examples/ResourceGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Resource"]},"patch":{"description":"Updating a Spatial Anchors Account","operationId":"SpatialAnchorsAccounts_Update","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/spatialAnchorsAccountNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/SpatialAnchorsAccount"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccount"},"examples":{"Update spatial anchors account":{"$ref":"#/components/examples/Update_spatial_anchors_account"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Resource"]},"put":{"description":"Creating or Updating a Spatial Anchors Account.","operationId":"SpatialAnchorsAccounts_Create","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/spatialAnchorsAccountNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"$ref":"#/components/requestBodies/SpatialAnchorsAccount"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccount"},"examples":{"ResourceCreate":{"$ref":"#/components/examples/ResourceCreate"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccount"},"examples":{"ResourceCreate":{"$ref":"#/components/examples/ResourceCreate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Resource"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}/keys":{"get":{"description":"Get Both of the 2 Keys of a Spatial Anchors Account","operationId":"SpatialAnchorsAccounts_GetKeys","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/spatialAnchorsAccountNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccountKeys"},"examples":{"ResourceRegenerateKey":{"$ref":"#/components/examples/ResourceRegenerateKey"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Key"]},"post":{"description":"Regenerate 1 Key of a Spatial Anchors Account","operationId":"SpatialAnchorsAccounts_RegenerateKeys","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/spatialAnchorsAccountNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccountKeyRegenerateRequest"}}},"description":"Specifying which key to be regenerated.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccountKeys"},"examples":{"ResourceRegenerateKey":{"$ref":"#/components/examples/ResourceRegenerateKey"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Key"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"OperationList":{"value":{"value":[{"display":{"description":"Registers a subscription for the Mixed Reality resource provider.","operation":"Registers the Mixed Reality resource provider","provider":"Microsoft.MixedReality","resource":"Mixed Reality resource provider"},"name":"Microsoft.MixedReality/register/action"},{"display":{"description":"Deletes the resource for Microsoft.MixedReality/SpatialAnchorsAccounts","operation":"Delete Spatial Anchors Accounts","provider":"Microsoft.MixedReality","resource":"SpatialAnchorsAccounts"},"name":"Microsoft.MixedReality/SpatialAnchorsAccounts/delete"},{"display":{"description":"Gets the resource for Microsoft.MixedReality/SpatialAnchorsAccounts","operation":"Get Spatial Anchors Accounts","provider":"Microsoft.MixedReality","resource":"SpatialAnchorsAccounts"},"name":"Microsoft.MixedReality/SpatialAnchorsAccounts/read"},{"display":{"description":"Updates the resource for Microsoft.MixedReality/SpatialAnchorsAccounts","operation":"Update Spatial Anchors Accounts","provider":"Microsoft.MixedReality","resource":"SpatialAnchorsAccounts"},"name":"Microsoft.MixedReality/SpatialAnchorsAccounts/write"}]}},"CheckLocalNameAvailability":{"value":{"message":"...","nameAvailable":"false","reason":"AlreadyExists"}},"SpatialAnchorsAccountListBySubscription":{"value":{"nextLink":"https://aka.ms/&^FDKKAR","value":[{"id":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.MixedReality/SpatialAnchorsAccounts/MyAccount","location":"eastus2euap","name":"MyAccount","properties":{"accountDomain":"mixedreality.azure.com","accountId":"5007a881-6fb4-4c93-be52-942e355944a5"},"tags":{},"type":"Microsoft.MixedReality/SpatialAnchorsAccounts"},{"id":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.MixedReality/SpatialAnchorsAccounts/omega","location":"eastus2euap","name":"omega","properties":{"accountDomain":"mixedreality.azure.com","accountId":"5007a881-6fb4-4c93-be52-942e355944a5"},"tags":{},"type":"Microsoft.MixedReality/SpatialAnchorsAccounts"}]}},"ResourceGet":{"value":{"id":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.MixedReality/SpatialAnchorsAccounts/MyAccount","location":"eastus2euap","name":"MyAccount","properties":{"accountDomain":"mixedreality.azure.com","accountId":"5007a881-6fb4-4c93-be52-942e355944a5"},"tags":{},"type":"Microsoft.MixedReality/SpatialAnchorsAccounts"}},"Update_spatial_anchors_account":{"value":{"id":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.MixedReality/SpatialAnchorsAccounts/MyAccount","location":"eastus2euap","name":"MyAccount","properties":{"accountDomain":"mixedreality.azure.com","accountId":"5007a881-6fb4-4c93-be52-942e355944a5"},"tags":{"hero":"romeo","heroine":"juliet"},"type":"Microsoft.MixedReality/SpatialAnchorsAccounts"}},"ResourceCreate":{"value":{"id":"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.MixedReality/SpatialAnchorsAccounts/MyAccount","location":"eastus2euap","name":"MyAccount","properties":{"accountDomain":"mixedreality.azure.com","accountId":"5007a881-6fb4-4c93-be52-942e355944a5"},"tags":{},"type":"Microsoft.MixedReality/SpatialAnchorsAccounts"}},"ResourceRegenerateKey":{"value":{"primaryKey":"vMAlcI/j25TwDs8hjTorto3JQkoiqZAXKsFq0rYnSNc=","secondaryKey":"N4umIGhJt8LgnMMMBpwFOxVOS9zpxHxSHy1TJhN3hU4="}}},"parameters":{"apiVersionParameter":{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"OperationList":{"value":"2019-02-28-preview"},"CheckLocalNameAvailability":{"value":"2019-02-28-preview"},"SpatialAnchorsAccountListBySubscription":{"value":"2019-02-28-preview"},"ResourceGet":{"value":"2019-02-28-preview"},"ResourceDelete":{"value":"2019-02-28-preview"},"Update spatial anchors account":{"value":"2019-02-28-preview"},"ResourceCreate":{"value":"2019-02-28-preview"},"ResourceRegenerateKey":{"value":"2019-02-28-preview"}}},"locationParameter":{"description":"The location in which uniqueness will be verified.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"CheckLocalNameAvailability":{"value":"eastus2euap"}}},"resourceGroupNameParameter":{"description":"Name of an Azure resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"ResourceGet":{"value":"MyResourceGroup"},"ResourceDelete":{"value":"MyResourceGroup"},"Update spatial anchors account":{"value":"MyResourceGroup"},"ResourceCreate":{"value":"MyResourceGroup"},"ResourceRegenerateKey":{"value":"MyResourceGroup"}}},"spatialAnchorsAccountNameParameter":{"description":"Name of an Mixed Reality Spatial Anchors Account.","in":"path","name":"spatialAnchorsAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"ResourceDelete":{"value":"MyAccount"},"ResourceGet":{"value":"MyAccount"},"Update spatial anchors account":{"value":"MyAccount"},"ResourceCreate":{"value":"MyAccount"},"ResourceRegenerateKey":{"value":"MyAccount"}}},"subscriptionIdParameter":{"description":"Azure subscription ID.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"CheckLocalNameAvailability":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"SpatialAnchorsAccountListBySubscription":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"ResourceGet":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"ResourceDelete":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"Update spatial anchors account":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"ResourceCreate":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"ResourceRegenerateKey":{"value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}},"requestBodies":{"SpatialAnchorsAccount":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpatialAnchorsAccount"}}},"description":"Spatial Anchors Account parameter.","required":true,"x-ms-parameter-location":"method"}},"securitySchemes":{"azure_auth":{"description":"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":{"CheckNameAvailabilityRequest":{"description":"Check Name Availability Request","properties":{"name":{"description":"Resource Name To Verify","type":"string"},"type":{"description":"Fully qualified resource type which includes provider namespace","type":"string"}},"required":["name","type"],"type":"object"},"CheckNameAvailabilityResponse":{"description":"Check Name Availability Response","properties":{"message":{"description":"detail message","type":"string"},"nameAvailable":{"$ref":"#/components/schemas/NameAvailability"},"reason":{"$ref":"#/components/schemas/NameUnavailableReason"}},"required":["nameAvailable"],"type":"object"},"ErrorResponse":{"description":"Response on Error","properties":{"code":{"description":"String that can be used to programmatically identify the error.","type":"string"},"details":{"description":"An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema.","type":"string"},"message":{"description":"Describes the error in detail and provides debugging information","type":"string"},"target":{"description":"The target of the particular error","type":"string"}},"required":["message","code"],"type":"object"},"NameAvailability":{"description":"Whether or not the name is available.","enum":["true","false"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"NameAvailability"}},"NameUnavailableReason":{"description":"reason of name unavailable.","enum":["Invalid","AlreadyExists"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"NameUnavailableReason"}},"Operation":{"description":"REST API operation","properties":{"display":{"$ref":"#/components/schemas/OperationDisplay"},"name":{"description":"Operation name: {provider}/{resource}/{operation}","type":"string"}},"type":"object"},"OperationDisplay":{"description":"The object that represents the operation.","properties":{"description":{"description":"Description of operation","type":"string"},"operation":{"description":"Operation type: Read, write, delete, etc.","type":"string"},"provider":{"description":"Service provider: Microsoft.ResourceProvider","type":"string"},"resource":{"description":"Resource on which the operation is performed: Profile, endpoint, etc.","type":"string"}},"required":["provider","resource","operation","description"],"type":"object"},"OperationList":{"description":"Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.","properties":{"nextLink":{"description":"URL to get the next set of operation list results if there are any.","type":"string"},"value":{"description":"List of operations supported by the Resource Provider.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"}}},"SpatialAnchorsAccount":{"allOf":[{"allOf":[{"properties":{"id":{"description":"Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}","readOnly":true,"type":"string"},"name":{"description":"The name of the resource","readOnly":true,"type":"string"},"type":{"description":"The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"The resource model definition for a ARM tracked top level resource","properties":{"location":{"description":"The geo-location where the resource lives","type":"string","x-ms-mutability":["read","create"]},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object","x-ms-mutability":["read","create","update"]}},"required":["location"]}],"description":"SpatialAnchorsAccount Response.","properties":{"properties":{"$ref":"#/components/schemas/SpatialAnchorsAccountProperties"}},"type":"object"},"SpatialAnchorsAccountKeyRegenerateRequest":{"description":"Spatial Anchors Account Regenerate Key","properties":{"serial":{"default":1,"description":"serial of key to be regenerated","enum":[1,2],"type":"integer","x-ms-enum":{"name":"Serial","values":[{"description":"The Primary Key","name":"Primary","value":1},{"description":"The Secondary Key","name":"Secondary","value":2}]}}},"type":"object"},"SpatialAnchorsAccountKeys":{"description":"Spatial Anchors Account Keys","properties":{"primaryKey":{"description":"value of primary key.","readOnly":true,"type":"string"},"secondaryKey":{"description":"value of secondary key.","readOnly":true,"type":"string"}},"type":"object"},"SpatialAnchorsAccountList":{"description":"Result of the request to get resource collection. It contains a list of resources and a URL link to get the next set of results.","properties":{"nextLink":{"description":"URL to get the next set of resource list results if there are any.","type":"string"},"value":{"description":"List of resources supported by the Resource Provider.","items":{"$ref":"#/components/schemas/SpatialAnchorsAccount"},"type":"array"}},"type":"object"},"SpatialAnchorsAccountProperties":{"description":"Spatial Anchors Account Customize Properties","properties":{"accountDomain":{"description":"Correspond domain name of certain Spatial Anchors Account","readOnly":true,"type":"string"},"accountId":{"description":"unique id of certain Spatial Anchors Account data contract.","readOnly":true,"type":"string"}},"type":"object"}}}}