openapi-directory/api/azure.com/azurestack-Registration.json

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

{"openapi":"3.0.0","info":{"title":"Azure Stack Azure Bridge Client","version":"2017-06-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/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azurestack-Registration","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations":{"get":{"description":"Returns a list of all registrations.","operationId":"Registrations_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":{"Returns a list of all registrations.":{"value":"dd8597b4-8739-4467-8b10-f8679f62bfbf"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns a list of all registrations.":{"value":"azurestack"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2017-06-01"},"examples":{"Returns a list of all registrations.":{"value":"2017-06-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationList"},"examples":{"Returns a list of all registrations.":{"$ref":"#/components/examples/Returns_a_list_of_all_registrations."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.","properties":{"error":{"description":"The details of the error.","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"Error message indicating why the operation failed.","readOnly":true,"type":"string"},"target":{"description":"The target of the particular error.","readOnly":true,"type":"string"}}}},"type":"object"}}}}},"tags":["Registrations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}":{"delete":{"description":"Delete the requested Azure Stack registration.","operationId":"Registrations_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":{"Delete the requested Azure Stack registration.":{"value":"dd8597b4-8739-4467-8b10-f8679f62bfbf"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete the requested Azure Stack registration.":{"value":"azurestack"}}},{"description":"Name of the Azure Stack registration.","in":"path","name":"registrationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete the requested Azure Stack registration.":{"value":"testregistration"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2017-06-01"},"examples":{"Delete the requested Azure Stack registration.":{"value":"2017-06-01"}}}],"responses":{"200":{"description":"OK"},"204":{"description":"NO CONTENT"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.","properties":{"error":{"description":"The details of the error.","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"Error message indicating why the operation failed.","readOnly":true,"type":"string"},"target":{"description":"The target of the particular error.","readOnly":true,"type":"string"}}}},"type":"object"}}}}},"tags":["Registrations"]},"get":{"description":"Returns the properties of an Azure Stack registration.","operationId":"Registrations_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":{"Returns the properties of an Azure Stack registration.":{"value":"dd8597b4-8739-4467-8b10-f8679f62bfbf"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns the properties of an Azure Stack registration.":{"value":"azurestack"}}},{"description":"Name of the Azure Stack registration.","in":"path","name":"registrationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns the properties of an Azure Stack registration.":{"value":"testregistration"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2017-06-01"},"examples":{"Returns the properties of an Azure Stack registration.":{"value":"2017-06-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Registration"},"examples":{"Returns the properties of an Azure Stack registration.":{"$ref":"#/components/examples/Returns_the_properties_of_an_Azure_Stack_registration."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.","properties":{"error":{"description":"The details of the error.","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"Error message indicating why the operation failed.","readOnly":true,"type":"string"},"target":{"description":"The target of the particular error.","readOnly":true,"type":"string"}}}},"type":"object"}}}}},"tags":["Registrations"]},"patch":{"description":"Patch an Azure Stack registration.","operationId":"Registrations_Update","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":{"Patch an Azure Stack registration.":{"value":"dd8597b4-8739-4467-8b10-f8679f62bfbf"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Patch an Azure Stack registration.":{"value":"azurestack"}}},{"description":"Name of the Azure Stack registration.","in":"path","name":"registrationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Patch an Azure Stack registration.":{"value":"testregistration"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2017-06-01"},"examples":{"Patch an Azure Stack registration.":{"value":"2017-06-01"}}}],"requestBody":{"$ref":"#/components/requestBodies/RegistrationParameter"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Registration"},"examples":{"Patch an Azure Stack registration.":{"$ref":"#/components/examples/Patch_an_Azure_Stack_registration."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.","properties":{"error":{"description":"The details of the error.","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"Error message indicating why the operation failed.","readOnly":true,"type":"string"},"target":{"description":"The target of the particular error.","readOnly":true,"type":"string"}}}},"type":"object"}}}}},"tags":["Registrations"]},"put":{"description":"Create or update an Azure Stack registration.","operationId":"Registrations_CreateOrUpdate","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":{"Create or update an Azure Stack registration.":{"value":"dd8597b4-8739-4467-8b10-f8679f62bfbf"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update an Azure Stack registration.":{"value":"azurestack"}}},{"description":"Name of the Azure Stack registration.","in":"path","name":"registrationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update an Azure Stack registration.":{"value":"testregistration"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2017-06-01"},"examples":{"Create or update an Azure Stack registration.":{"value":"2017-06-01"}}}],"requestBody":{"$ref":"#/components/requestBodies/RegistrationParameter"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Registration"},"examples":{"Create or update an Azure Stack registration.":{"$ref":"#/components/examples/Create_or_update_an_Azure_Stack_registration."}}}}},"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Registration"},"examples":{"Create or update an Azure Stack registration.":{"$ref":"#/components/examples/Create_or_update_an_Azure_Stack_registration."}}}}}},"tags":["Registrations"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/getactivationkey":{"post":{"description":"Returns Azure Stack Activation Key.","operationId":"Registrations_GetActivationKey","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":{"Returns Azure Stack Activation Key.":{"value":"dd8597b4-8739-4467-8b10-f8679f62bfbf"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroup","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns Azure Stack Activation Key.":{"value":"azurestack"}}},{"description":"Name of the Azure Stack registration.","in":"path","name":"registrationName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns Azure Stack Activation Key.":{"value":"testregistration"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2017-06-01"},"examples":{"Returns Azure Stack Activation Key.":{"value":"2017-06-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationKeyResult"},"examples":{"Returns Azure Stack Activation Key.":{"$ref":"#/components/examples/Returns_Azure_Stack_Activation_Key."}}}}}},"tags":["Registrations"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Returns_a_list_of_all_registrations.":{"value":{"value":[{"etag":"0d00527e-0000-0000-0000-5a81ebdf0000","id":"/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration","location":"global","name":"testregistration","properties":{"billingModel":"Development","objectId":"9e9704ab-561a-4498-ac60-64b2314456ee"},"type":"Microsoft.AzureStack/registrations"}]}},"Returns_the_properties_of_an_Azure_Stack_registration.":{"value":{"etag":"0d00527e-0000-0000-0000-5a81ebdf0000","id":"/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration","location":"global","name":"azurestack","properties":{"billingModel":"Development","objectId":"9e9704ab-561a-4498-ac60-64b2314456ee"},"type":"Microsoft.AzureStack/registrations"}},"Patch_an_Azure_Stack_registration.":{"value":{"etag":"\"0e00ab2b-0000-0000-0000-5a82517f0000\"","id":"/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration","location":"global","name":"testregistration","properties":{"billingModel":"Development","cloudId":"5bf881b2-6be7-42a1-9f47-d6fcb6737747","objectId":"2dbdd5f4-daf3-442a-be35-b71c3debee5a"},"tags":{"key1":"value1"},"type":"Microsoft.AzureStack/registrations"}},"Create_or_update_an_Azure_Stack_registration.":{"value":{"etag":"\"0e00ab2b-0000-0000-0000-5a82517f0000\"","id":"/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration","location":"global","name":"testregistration","properties":{"billingModel":"Development","cloudId":"5bf881b2-6be7-42a1-9f47-d6fcb6737747","objectId":"2dbdd5f4-daf3-442a-be35-b71c3debee5a"},"type":"Microsoft.AzureStack/registrations"}},"Returns_Azure_Stack_Activation_Key.":{"value":{"activationKey":"EYJRawQioiIzyzkYoDA2zJRJotc0Odg1oDHLM2zIYJfJmTzkYmQ2yYISiCjHbgCIoIjsuZi1niJ9.EyjZDWjzy3JPchrpB25JzcI6iJKWmdfmMZZLltqXzguTngVKYi05oTEZLTc4MGZhnWQWnMiZnIIsiNJLC291CMNLR3JVdXBOyw1LijoiDgVzDciSinjLZ2lZdHJHDGLvbK5hBwuIoijheNN0zxN0czU2mTyilCJjzXJ0UglUbmLuz1JvB3RtDWjqZWn0CyI6WYJDtj1cywx0Aw1vCMugq3liZXJucNvZDCBSB290LCbpVT1dEWJlCLrYdXn0LCbPpuJhBHRPBw9yzSwGqz1JrsJdlcJJZXJ0UglUBMlUZ0ludGvYBwvKawf0zvroDw1iChJPbnRziJpbiJQxN0uYmjUWmZDgQKZBqtrgOTU3NjFeNUfFnzi5RTfBRue3rTNBndiIlCi1neq5rdIWmJM5MdGwqzMYmzE2RuQ5RKY5oDbbnDg5ODHgNeFERjjEiIwiOEEzodc1nuqWotK2ODizRKU4RKezMtE2QtI3N0nfnDQ2rUfdnEu5osisiKFeodk4Qum3M0RgMZMZRUi2mEfDMUy1rKm2QZRcmjiXoUrEQjc5qJCILCI5n0vgrJMWmjg2NZC4oTrcREq0RjLbQzUzrjC4ouJfrTvErJrBrdg2IIWIOTq4rTe2ntI1odYyNdbEndUZMJG3Qui2OuNBrUi4RjJgNEyWmJExnYjdLCJ1c2FnzuVuZhbVaW50IjoIAhr0Chm6Ly9HEnn0DxnndgvzDHdJDtaWMs50cMFMzmLjbwFUywdlCI5UZxQilcjtYxjRZXRwbgFJzUvUzhBVAw50IJoiahR0chm6Ly9tyw5hZ2vTZw50LMf6dxJllMNVBsIsiNVzywdLUMvzb3VyY2VVcmKioIJODHRWczoVl3VzYWDllM1pY3jVC29MdGF6dXJLC3rhy2sUy29tiIwIbwfya2v0cgxhy2vsZxnvdxjJzvvYaSI6imh0dHbzOI8vBWfya2V0CgXhy2uubWLjCm9zb2z0YXp1CmVZdgFjAY5JB20IlcJleHBpCMvzIjoioTk5oS0xMi0zmFQyMzo1OTo1OS45OtK5OTk5wiiSiMNsB3vKswQIoIi2otQ2NDg5ns0ZYTfHLtQ1mgeTotGyNC00yjc2mdhKoTIWM2YIlcJvYMplY3RjzcI6IjvIM2iWNMe4lTljnmmTNdG4OC05ZWiZlWU4y2Rhy2U3NdC5NSisimJPBGxPBmDnb2rlBcI6IKrLdmvsB3btZW50iiWIAGFyzHDHcmvjbMZvijPbEYJUYW1LijoISEMxDTe1YTAYmTIilcj1dwLKiJOINWM5mwu3njyTmjU5Os00oTiwLwi0oDmTNgzhoTiwM2rJYtcxIIWIbnVtq29YZxMIOJISImJpb3MioLsiM2RKMMEwmDDHmtk0nDMwNDhiZmRMyJK4MzC5NjdlY2YiXswibmljIJPBIMvlnjrlmMmXzMRjyzQ5Y2u4n2UXYZzlMZrIzmrimzBhiiwImdc2oWexn2vjzdg2ngM1YwjlnzVJmjLKZjM4mzdjzwMIXSWIy3b1iJpbIjy4Ntm5mgJJzGE0mDRiZgq5ytHhOtK5MGvLZgNkzjM0iiwiMzi3nzGzzWy3n2I4NgqzyJLhmWqYOwe0NzvKOGvLyzuixsWizglzayI6WYI5y2VmNwe3MZU5nDQ0nTc2ymu3yzdmYwnmzJmXmmflmiiSIMvmowyZmMEXZwfhodQ1ntq5ndM1zTUwmDqZMGJhmwnIIL0sIm1LBW9YesI6wyIwMMQwnznHYZC1NGE0ZmuxYTG5mwqzZDhMoWUWMgq2MSISijC3MGU4ZTQ0ODk0YZQwM2RiOTBMZWE2nWYWOwqxyjZkiL19XswidXNhz2vSZXbvCnrpBMDFbMFibGVKijPmyWxzzSwIBWfYa2V0CgXhy2VTEW5KAWNhdgLVBKvuywjszwqIOnryDwUsiMLZC3vlCii6INnvBwvvbMUILcJ2ZXJzaw9uIJOims4WIn0.NkqXrYRthQij4vCeR06SRCIkl44HIRzH8SyOH7za8cm_ObTWk4ZPls_SPYDqQXsOC-SdWUFf1-zbYLbXHSNWpIM_Z6NF2WgMceW78ynPf96sxX9o2R8zcUFf16O0IFqb4SJAlD_JZAsQrdQuC4JkA1AjLFjE4NkTVdxAumK61Ie31C91Nlkqzqyv6cjzoFaj9ybrBu_lTR9-7GR8RxPfpwgNdScRo6VbDQcne8y45PEujA0x-vugmoXjCA7ONM1Z5A2iidzzLEXpHjGHZ5qLMkaQkaN0DimgXw19GlWTFUjDY4JhfEptLdIRlOEpJGn4pmyIYktvHO2W2u5SLcIWha"}}},"requestBodies":{"RegistrationParameter":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationParameter"}}},"description":"Registration token","required":true,"x-ms-parameter-location":"method"}},"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":{"ActivationKeyResult":{"description":"The resource containing the Azure Stack activation key.","properties":{"activationKey":{"description":"Azure Stack activation key.","type":"string"}},"type":"object"},"Registration":{"allOf":[{"description":"Base resource object.","properties":{"etag":{"description":"The entity tag used for optimistic concurrency when modifying the resource.","type":"string"},"id":{"description":"ID of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","enum":["global"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Location"},"x-ms-mutability":["create","read"]},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Custom tags for the resource.","type":"object"},"type":{"description":"Type of Resource.","readOnly":true,"type":"string"}},"required":["location"],"type":"object","x-ms-azure-resource":true}],"description":"Registration information.","properties":{"properties":{"$ref":"#/components/schemas/RegistrationProperties"}},"type":"object"},"RegistrationList":{"description":"Pageable list of registrations.","properties":{"nextLink":{"description":"URI to the next page.","type":"string"},"value":{"description":"List of Registrations","items":{"$ref":"#/components/schemas/Registration"},"type":"array"}},"type":"object"},"RegistrationParameter":{"description":"Registration resource","properties":{"location":{"description":"Location of the resource.","enum":["global"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Location"},"x-ms-mutability":["create","read"]},"properties":{"$ref":"#/components/schemas/RegistrationParameterProperties"}},"type":"object"},"RegistrationParameterProperties":{"description":"Properties of the Azure Stack registration resource","properties":{"registrationToken":{"description":"The token identifying registered Azure Stack","type":"string"}},"required":["registrationToken"],"type":"object"},"RegistrationProperties":{"description":"Properties portion of the registration resource.","properties":{"billingModel":{"description":"Specifies the billing mode for the Azure Stack registration.","type":"string"},"cloudId":{"description":"The identifier of the registered Azure Stack.","type":"string"},"objectId":{"description":"The object identifier associated with the Azure Stack connecting to Azure.","type":"string"}},"type":"object"}}}}