azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.i...

165 строки
13 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties"
name: "StorageEndpointProperties"
nameWithType: "StorageEndpointProperties"
summary: "The properties of the Azure Storage endpoint for file upload."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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#equals-java.lang.Object-\">equals</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#hashCode--\">hashCode</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#toString--\">toString</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 final class **StorageEndpointProperties**"
constructors:
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.StorageEndpointProperties()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.StorageEndpointProperties()"
name: "StorageEndpointProperties()"
nameWithType: "StorageEndpointProperties.StorageEndpointProperties()"
summary: "Creates an instance of Storage<wbr>Endpoint<wbr>Properties class."
syntax: "public StorageEndpointProperties()"
desc: "Creates an instance of StorageEndpointProperties class."
methods:
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.authenticationType()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.authenticationType()"
name: "authenticationType()"
nameWithType: "StorageEndpointProperties.authenticationType()"
summary: "Get the authentication<wbr>Type property: Specifies authentication type being used for connecting to the storage account."
syntax: "public AuthenticationType authenticationType()"
desc: "Get the authenticationType property: Specifies authentication type being used for connecting to the storage account."
returns:
description: "the authenticationType value."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.AuthenticationType?alt=com.azure.resourcemanager.iothub.models.AuthenticationType&text=AuthenticationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.connectionString()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.connectionString()"
name: "connectionString()"
nameWithType: "StorageEndpointProperties.connectionString()"
summary: "Get the connection<wbr>String property: The connection string for the Azure Storage account to which files are uploaded."
syntax: "public String connectionString()"
desc: "Get the connectionString property: The connection string for the Azure Storage account to which files are uploaded."
returns:
description: "the connectionString value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.containerName()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.containerName()"
name: "containerName()"
nameWithType: "StorageEndpointProperties.containerName()"
summary: "Get the container<wbr>Name property: The name of the root container where you upload files."
syntax: "public String containerName()"
desc: "Get the containerName property: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified."
returns:
description: "the containerName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.identity()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.identity()"
name: "identity()"
nameWithType: "StorageEndpointProperties.identity()"
summary: "Get the identity property: Managed identity properties of storage endpoint for file upload."
syntax: "public ManagedIdentity identity()"
desc: "Get the identity property: Managed identity properties of storage endpoint for file upload."
returns:
description: "the identity value."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.ManagedIdentity?alt=com.azure.resourcemanager.iothub.models.ManagedIdentity&text=ManagedIdentity\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.sasTtlAsIso8601()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.sasTtlAsIso8601()"
name: "sasTtlAsIso8601()"
nameWithType: "StorageEndpointProperties.sasTtlAsIso8601()"
summary: "Get the sas<wbr>Ttl<wbr>AsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid."
syntax: "public Duration sasTtlAsIso8601()"
desc: "Get the sasTtlAsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload\\#file-upload-notification-configuration-options."
returns:
description: "the sasTtlAsIso8601 value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.validate()"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.validate()"
name: "validate()"
nameWithType: "StorageEndpointProperties.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withAuthenticationType(com.azure.resourcemanager.iothub.models.AuthenticationType)"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withAuthenticationType(AuthenticationType authenticationType)"
name: "withAuthenticationType(AuthenticationType authenticationType)"
nameWithType: "StorageEndpointProperties.withAuthenticationType(AuthenticationType authenticationType)"
summary: "Set the authentication<wbr>Type property: Specifies authentication type being used for connecting to the storage account."
parameters:
- description: "the authenticationType value to set."
name: "authenticationType"
type: "<xref href=\"com.azure.resourcemanager.iothub.models.AuthenticationType?alt=com.azure.resourcemanager.iothub.models.AuthenticationType&text=AuthenticationType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public StorageEndpointProperties withAuthenticationType(AuthenticationType authenticationType)"
desc: "Set the authenticationType property: Specifies authentication type being used for connecting to the storage account."
returns:
description: "the StorageEndpointProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.StorageEndpointProperties?alt=com.azure.resourcemanager.iothub.models.StorageEndpointProperties&text=StorageEndpointProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withConnectionString(java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withConnectionString(String connectionString)"
name: "withConnectionString(String connectionString)"
nameWithType: "StorageEndpointProperties.withConnectionString(String connectionString)"
summary: "Set the connection<wbr>String property: The connection string for the Azure Storage account to which files are uploaded."
parameters:
- description: "the connectionString value to set."
name: "connectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public StorageEndpointProperties withConnectionString(String connectionString)"
desc: "Set the connectionString property: The connection string for the Azure Storage account to which files are uploaded."
returns:
description: "the StorageEndpointProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.StorageEndpointProperties?alt=com.azure.resourcemanager.iothub.models.StorageEndpointProperties&text=StorageEndpointProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withContainerName(java.lang.String)"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withContainerName(String containerName)"
name: "withContainerName(String containerName)"
nameWithType: "StorageEndpointProperties.withContainerName(String containerName)"
summary: "Set the container<wbr>Name property: The name of the root container where you upload files."
parameters:
- description: "the containerName value to set."
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public StorageEndpointProperties withContainerName(String containerName)"
desc: "Set the containerName property: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified."
returns:
description: "the StorageEndpointProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.StorageEndpointProperties?alt=com.azure.resourcemanager.iothub.models.StorageEndpointProperties&text=StorageEndpointProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withIdentity(com.azure.resourcemanager.iothub.models.ManagedIdentity)"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withIdentity(ManagedIdentity identity)"
name: "withIdentity(ManagedIdentity identity)"
nameWithType: "StorageEndpointProperties.withIdentity(ManagedIdentity identity)"
summary: "Set the identity property: Managed identity properties of storage endpoint for file upload."
parameters:
- description: "the identity value to set."
name: "identity"
type: "<xref href=\"com.azure.resourcemanager.iothub.models.ManagedIdentity?alt=com.azure.resourcemanager.iothub.models.ManagedIdentity&text=ManagedIdentity\" data-throw-if-not-resolved=\"False\" />"
syntax: "public StorageEndpointProperties withIdentity(ManagedIdentity identity)"
desc: "Set the identity property: Managed identity properties of storage endpoint for file upload."
returns:
description: "the StorageEndpointProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.StorageEndpointProperties?alt=com.azure.resourcemanager.iothub.models.StorageEndpointProperties&text=StorageEndpointProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withSasTtlAsIso8601(java.time.Duration)"
fullName: "com.azure.resourcemanager.iothub.models.StorageEndpointProperties.withSasTtlAsIso8601(Duration sasTtlAsIso8601)"
name: "withSasTtlAsIso8601(Duration sasTtlAsIso8601)"
nameWithType: "StorageEndpointProperties.withSasTtlAsIso8601(Duration sasTtlAsIso8601)"
summary: "Set the sas<wbr>Ttl<wbr>AsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid."
parameters:
- description: "the sasTtlAsIso8601 value to set."
name: "sasTtlAsIso8601"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public StorageEndpointProperties withSasTtlAsIso8601(Duration sasTtlAsIso8601)"
desc: "Set the sasTtlAsIso8601 property: The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload\\#file-upload-notification-configuration-options."
returns:
description: "the StorageEndpointProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.iothub.models.StorageEndpointProperties?alt=com.azure.resourcemanager.iothub.models.StorageEndpointProperties&text=StorageEndpointProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The properties of the Azure Storage endpoint for file upload."
metadata: {}
package: "com.azure.resourcemanager.iothub.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0