PurviewTypes.GetStructDefByName(String, RequestContext) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get the struct definition by its name (unique).
public virtual Azure.Response GetStructDefByName (string name, Azure.RequestContext context = default);
abstract member GetStructDefByName : string * Azure.RequestContext -> Azure.Response
override this.GetStructDefByName : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetStructDefByName (name As String, Optional context As RequestContext = Nothing) As Response
Parameters
- name
- String
The name of the struct.
- context
- RequestContext
The request context, which can override default behaviors on the request on a per-call basis.
Returns
Exceptions
name
is null.
name
is an empty string, and was expected to be non-empty.
Remarks
Schema for Response Body
:
{
category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE",
createTime: number,
createdBy: string,
dateFormatter: {
availableLocales: [string],
calendar: number,
dateInstance: DateFormat,
dateTimeInstance: DateFormat,
instance: DateFormat,
lenient: boolean,
numberFormat: {
availableLocales: [string],
currency: string,
currencyInstance: NumberFormat,
groupingUsed: boolean,
instance: NumberFormat,
integerInstance: NumberFormat,
maximumFractionDigits: number,
maximumIntegerDigits: number,
minimumFractionDigits: number,
minimumIntegerDigits: number,
numberInstance: NumberFormat,
parseIntegerOnly: boolean,
percentInstance: NumberFormat,
roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY"
},
timeInstance: DateFormat,
timeZone: {
dstSavings: number,
id: string,
availableIds: [string],
default: TimeZone,
displayName: string,
rawOffset: number
}
},
description: string,
guid: string,
name: string,
options: Dictionary<string, string>,
serviceType: string,
typeVersion: string,
updateTime: number,
updatedBy: string,
version: number,
lastModifiedTS: string,
attributeDefs: [
{
cardinality: "SINGLE" | "LIST" | "SET",
constraints: [
{
params: Dictionary<string, AnyObject>,
type: string
}
],
defaultValue: string,
description: string,
includeInNotification: boolean,
isIndexable: boolean,
isOptional: boolean,
isUnique: boolean,
name: string,
options: Dictionary<string, string>,
typeName: string,
valuesMaxCount: number,
valuesMinCount: number
}
]
}
Schema for Response Error
:
{
requestId: string,
errorCode: string,
errorMessage: string
}
Applies to
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för