Tenants - Patch

Service:

Azure Sphere Public API

API Version:

v2

Patch an Azure Sphere tenant.

PATCH https://prod.core.sphere.azure.net/v2/tenants/{tenantId}

URI Parameters

Name	In	Required	Type	Description
tenantId	path	True	string uuid	Guid of the tenant to be patched.

Request Body

Name	Type	Description
Name	string	The name of the tenant - this will be displayed to users and can be used to disambiguate for users who have multiple Azure Sphere tenants.

Responses

Name	Type	Description
200 OK	TenantIdentity	The patched object on success.
400 Bad Request	PublicApiErrorDetails[]	A collection of error details.
404 Not Found	PublicApiErrorDetails[]	A collection of error details.
500 Internal Server Error	PublicApiErrorDetails[]	A collection of error details.
Other Status Codes	PublicApiErrorDetails[]	A collection of error details.

Definitions

Name	Description
PublicApiErrorDetails
TenantIdentity
TenantPatchRequest

PublicApiErrorDetails

Name	Type	Description
Detail	string	A human-readable explanation specific to this occurrence of the problem.
ErrorCode	string	A string representation of PublicApiErrorCode defining the error.
Extensions		Gets the Dictionary for extension members.Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type.
Instance	string	A URI reference that identifies the specific occurrence of the problem.It mayor may not yield further information if dereferenced.
Status	integer	The HTTP status code([RFC7231], Section 6) generated by the origin server forthis occurrence of the problem.
Title	string	A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g.,using proactive content negotiation; see[RFC7231], Section 3.4).
Type	string	A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be blank.

TenantIdentity

Name	Type	Description
Id	string	Gets the Id of the tenant.
Name	string	Get the friendly name of the tenant.
Roles	string[]	Get the roles of the user in the tenant.

TenantPatchRequest

Name	Type	Description
Name	string	The name of the tenant - this will be displayed to users and can be used to disambiguate for users who have multiple Azure Sphere tenants.