azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.file.shar...

102 строки
9.1 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.file.share.models.ShareAudience"
fullName: "com.azure.storage.file.share.models.ShareAudience"
name: "ShareAudience"
nameWithType: "ShareAudience"
summary: "The audience to be used when requesting a token from Azure Active Directory (AAD)."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **ShareAudience**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.share.models.ShareAudience?alt=com.azure.storage.file.share.models.ShareAudience&text=ShareAudience\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.storage.file.share.models.ShareAudience.ShareAudience()"
fullName: "com.azure.storage.file.share.models.ShareAudience.ShareAudience()"
name: "ShareAudience()"
nameWithType: "ShareAudience.ShareAudience()"
summary: "Creates a new instance of <xref uid=\"com.azure.storage.file.share.models.ShareAudience\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAudience\"></xref> without a <xref uid=\"com.azure.storage.file.share.models.ShareAudience.toString*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toString()\"></xref> value."
deprecatedTag: "Use one of the constants or the <xref uid=\"com.azure.storage.file.share.models.ShareAudience.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareAudience()"
desc: "Creates a new instance of <xref uid=\"com.azure.storage.file.share.models.ShareAudience\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAudience\"></xref> without a <xref uid=\"com.azure.storage.file.share.models.ShareAudience.toString*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toString()\"></xref> value.\n\nThis constructor shouldn't be called as it will produce a <xref uid=\"com.azure.storage.file.share.models.ShareAudience\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareAudience\"></xref> which doesn't have a String enum value."
hasDeprecatedTag: true
fields:
- uid: "com.azure.storage.file.share.models.ShareAudience.AZURE_PUBLIC_CLOUD"
fullName: "com.azure.storage.file.share.models.ShareAudience.AZURE_PUBLIC_CLOUD"
name: "AZURE_PUBLIC_CLOUD"
nameWithType: "ShareAudience.AZURE_PUBLIC_CLOUD"
summary: "Gets default Audience used to acquire a token for authorizing requests to any Azure Storage account."
modifiers:
- "static"
- "final"
field:
type: "<xref href=\"com.azure.storage.file.share.models.ShareAudience?alt=com.azure.storage.file.share.models.ShareAudience&text=ShareAudience\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final ShareAudience AZURE_PUBLIC_CLOUD"
desc: "Gets default Audience used to acquire a token for authorizing requests to any Azure Storage account. If no audience is specified, this resource ID is the default value: \"https://storage.azure.com/\"."
methods:
- uid: "com.azure.storage.file.share.models.ShareAudience.createShareServiceAccountAudience(java.lang.String)"
fullName: "com.azure.storage.file.share.models.ShareAudience.createShareServiceAccountAudience(String storageAccountName)"
name: "createShareServiceAccountAudience(String storageAccountName)"
nameWithType: "ShareAudience.createShareServiceAccountAudience(String storageAccountName)"
summary: "The service endpoint for a given storage account."
modifiers:
- "static"
parameters:
- description: "The storage account name used to populate the service endpoint."
name: "storageAccountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static ShareAudience createShareServiceAccountAudience(String storageAccountName)"
desc: "The service endpoint for a given storage account. Use this method to acquire a token for authorizing requests to that specific Azure Storage account and service only."
returns:
description: "the audience with the file service endpoint."
type: "<xref href=\"com.azure.storage.file.share.models.ShareAudience?alt=com.azure.storage.file.share.models.ShareAudience&text=ShareAudience\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAudience.fromString(java.lang.String)"
fullName: "com.azure.storage.file.share.models.ShareAudience.fromString(String audience)"
name: "fromString(String audience)"
nameWithType: "ShareAudience.fromString(String audience)"
summary: "The Azure Active Directory audience to use when forming authorization scopes."
modifiers:
- "static"
parameters:
- description: "The Azure Active Directory audience to use when forming authorization scopes."
name: "audience"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static ShareAudience fromString(String audience)"
desc: "The Azure Active Directory audience to use when forming authorization scopes. For the Language service, this value corresponds to a URL that identifies the Azure cloud where the resource is located. For more information see [ Authorize access to Azure blobs using Azure Active Directory][Authorize access to Azure blobs using Azure Active Directory].\n\n\n[Authorize access to Azure blobs using Azure Active Directory]: https://learn.microsoft.com/en-us/azure/storage/blobs/authorize-access-azure-active-directory"
returns:
description: "the corresponding ShareAudience."
type: "<xref href=\"com.azure.storage.file.share.models.ShareAudience?alt=com.azure.storage.file.share.models.ShareAudience&text=ShareAudience\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAudience.values()"
fullName: "com.azure.storage.file.share.models.ShareAudience.values()"
name: "values()"
nameWithType: "ShareAudience.values()"
summary: "Gets known Share<wbr>Audience values."
modifiers:
- "static"
syntax: "public static Collection<ShareAudience> values()"
desc: "Gets known ShareAudience values."
returns:
description: "known ShareAudience values."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.azure.storage.file.share.models.ShareAudience?alt=com.azure.storage.file.share.models.ShareAudience&text=ShareAudience\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "The audience to be used when requesting a token from Azure Active Directory (AAD). Note: This audience only has an effect when authenticating a TokenCredential."
metadata: {}
package: "com.azure.storage.file.share.models"
artifact: com.azure:azure-storage-file-share:12.23.1